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

UpdateSCIMConfiguration

organizations.scim_configurations.update(ScimConfigurationUpdateParams**kwargs) -> ScimConfigurationUpdateResponse
POST/gitpod.v1.OrganizationService/UpdateSCIMConfiguration

Updates a SCIM configuration.

Use this method to:

  • Enable or disable SCIM provisioning
  • Link or unlink SSO configuration
  • Update configuration name

Examples

  • Disable SCIM:

    Disables SCIM provisioning.

    scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
enabled: false

  • Link to SSO:

    Links SCIM configuration to an SSO provider.

    scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ssoConfigurationId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
ParametersExpand Collapse
scim_configuration_id: str

scim_configuration_id is the ID of the SCIM configuration to update

formatuuid
enabled: Optional[bool]

enabled controls whether 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 SSO configuration to link

formatuuid
ReturnsExpand Collapse
class ScimConfigurationUpdateResponse: …
scim_configuration: ScimConfiguration

scim_configuration is the updated SCIM 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

UpdateSCIMConfiguration

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.update(
    scim_configuration_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
    enabled=False,
)
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"
  }
}