Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations

Scim Configurations

CreateSCIMConfiguration
organizations.scim_configurations.create(ScimConfigurationCreateParams**kwargs) -> ScimConfigurationCreateResponse
POST/gitpod.v1.OrganizationService/CreateSCIMConfiguration
DeleteSCIMConfiguration
organizations.scim_configurations.delete(ScimConfigurationDeleteParams**kwargs) -> object
POST/gitpod.v1.OrganizationService/DeleteSCIMConfiguration
ListSCIMConfigurations
organizations.scim_configurations.list(ScimConfigurationListParams**kwargs) -> SyncScimConfigurationsPage[ScimConfiguration]
POST/gitpod.v1.OrganizationService/ListSCIMConfigurations
RegenerateSCIMToken
organizations.scim_configurations.regenerate_token(ScimConfigurationRegenerateTokenParams**kwargs) -> ScimConfigurationRegenerateTokenResponse
POST/gitpod.v1.OrganizationService/RegenerateSCIMToken
GetSCIMConfiguration
organizations.scim_configurations.retrieve(ScimConfigurationRetrieveParams**kwargs) -> ScimConfigurationRetrieveResponse
POST/gitpod.v1.OrganizationService/GetSCIMConfiguration
UpdateSCIMConfiguration
organizations.scim_configurations.update(ScimConfigurationUpdateParams**kwargs) -> ScimConfigurationUpdateResponse
POST/gitpod.v1.OrganizationService/UpdateSCIMConfiguration
ModelsExpand 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
class ScimConfigurationCreateResponse: …
token: str

token is the bearer token for SCIM API authentication. This is only returned once during creation - store it securely.

scim_configuration: ScimConfiguration

scim_configuration is the created 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
token_expires_at: datetime

token_expires_at is when the token will expire

formatdate-time
class ScimConfigurationRegenerateTokenResponse: …
token: str

token is the new bearer token for SCIM API authentication. This invalidates the previous token - store it securely.

token_expires_at: datetime

token_expires_at is when the new token will expire

formatdate-time
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
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