Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations
Scim Configurations

GetSCIMConfiguration

organizations.scim_configurations.retrieve(ScimConfigurationRetrieveParams**kwargs) -> ScimConfigurationRetrieveResponse
POST/gitpod.v1.OrganizationService/GetSCIMConfiguration

Retrieves a specific SCIM configuration.

Use this method to:

  • View SCIM configuration details
  • Check if SCIM is enabled
  • Verify SSO linkage

Examples

  • Get SCIM configuration:

    Retrieves details of a specific SCIM configuration.

    scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
scim_configuration_id: str

scim_configuration_id is the ID of the SCIM configuration to get

formatuuid
ReturnsExpand Collapse
class ScimConfigurationRetrieveResponse: …
scim_configuration: ScimConfiguration

scim_configuration is the SCIM configuration identified by the ID

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

GetSCIMConfiguration

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
scim_configuration = client.organizations.scim_configurations.retrieve(
    scim_configuration_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(scim_configuration.scim_configuration)
{
  "scimConfiguration": {
    "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
{
  "scimConfiguration": {
    "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"
  }
}