ListSCIMConfigurations

organizations.scim_configurations.list() -> SyncScimConfigurationsPage[ScimConfiguration]

POST/gitpod.v1.OrganizationService/ListSCIMConfigurations

Lists SCIM configurations for an organization.

Use this method to:

View all SCIM configurations
Monitor provisioning status
Audit SCIM settings

Examples

List SCIM configurations:

Shows all SCIM configurations for an organization.
```
pagination:
  pageSize: 20
```

ParametersExpand Collapse

token: Optional[str]

page_size: Optional[int]

maximum100

minimum0

pagination: Optional[Pagination]

token: Optional[str]

Token for the next set of results that was returned as next_token of a PaginationResponse

page_size: Optional[int]

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

ReturnsExpand Collapse

class ScimConfiguration: …

SCIMConfiguration represents a SCIM 2.0 provisioning configuration

id: str

id is the unique identifier of the SCIM configuration

formatuuid

created_at: datetime

created_at is when the SCIM configuration was created

formatdate-time

organization_id: str

organization_id is the ID of the organization this SCIM configuration belongs to

formatuuid

token_expires_at: datetime

token_expires_at is when the current SCIM token expires

formatdate-time

updated_at: datetime

updated_at is when the SCIM configuration was last updated

formatdate-time

enabled: Optional[bool]

enabled indicates if SCIM provisioning is active

name: Optional[str]

name is a human-readable name for the SCIM configuration

maxLength128

sso_configuration_id: Optional[str]

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

ListSCIMConfigurations

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.organizations.scim_configurations.list(
    pagination={
        "page_size": 20
    },
)
page = page.scim_configurations[0]
print(page.id)

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "scimConfigurations": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "tokenExpiresAt": "2019-12-27T18:11:19.117Z",
      "updatedAt": "2019-12-27T18:11:19.117Z",
      "enabled": true,
      "name": "name",
      "ssoConfigurationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ]
}

Returns Examples

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "scimConfigurations": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "tokenExpiresAt": "2019-12-27T18:11:19.117Z",
      "updatedAt": "2019-12-27T18:11:19.117Z",
      "enabled": true,
      "name": "name",
      "ssoConfigurationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ]
}