Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations

Scim Configurations

CreateSCIMConfiguration
POST/gitpod.v1.OrganizationService/CreateSCIMConfiguration
DeleteSCIMConfiguration
POST/gitpod.v1.OrganizationService/DeleteSCIMConfiguration
ListSCIMConfigurations
POST/gitpod.v1.OrganizationService/ListSCIMConfigurations
RegenerateSCIMToken
POST/gitpod.v1.OrganizationService/RegenerateSCIMToken
GetSCIMConfiguration
POST/gitpod.v1.OrganizationService/GetSCIMConfiguration
UpdateSCIMConfiguration
POST/gitpod.v1.OrganizationService/UpdateSCIMConfiguration
ModelsExpand Collapse
ScimConfiguration object { id, createdAt, organizationId, 5 more }

SCIMConfiguration represents a SCIM 2.0 provisioning configuration

id: string

id is the unique identifier of the SCIM configuration

formatuuid
createdAt: string

created_at is when the SCIM configuration was created

formatdate-time
organizationId: string

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

formatuuid
tokenExpiresAt: string

token_expires_at is when the current SCIM token expires

formatdate-time
updatedAt: string

updated_at is when the SCIM configuration was last updated

formatdate-time
enabled: optional boolean

enabled indicates if SCIM provisioning is active

name: optional string

name is a human-readable name for the SCIM configuration

maxLength128
ssoConfigurationId: optional string

sso_configuration_id is the linked SSO configuration (optional)

formatuuid
ScimConfigurationCreateResponse object { token, scimConfiguration, tokenExpiresAt }
token: string

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

scimConfiguration: ScimConfiguration { id, createdAt, organizationId, 5 more }

scim_configuration is the created SCIM configuration

id: string

id is the unique identifier of the SCIM configuration

formatuuid
createdAt: string

created_at is when the SCIM configuration was created

formatdate-time
organizationId: string

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

formatuuid
tokenExpiresAt: string

token_expires_at is when the current SCIM token expires

formatdate-time
updatedAt: string

updated_at is when the SCIM configuration was last updated

formatdate-time
enabled: optional boolean

enabled indicates if SCIM provisioning is active

name: optional string

name is a human-readable name for the SCIM configuration

maxLength128
ssoConfigurationId: optional string

sso_configuration_id is the linked SSO configuration (optional)

formatuuid
tokenExpiresAt: string

token_expires_at is when the token will expire

formatdate-time
ScimConfigurationDeleteResponse = unknown
ScimConfigurationRegenerateTokenResponse object { token, tokenExpiresAt }
token: string

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

tokenExpiresAt: string

token_expires_at is when the new token will expire

formatdate-time
ScimConfigurationRetrieveResponse object { scimConfiguration }
scimConfiguration: ScimConfiguration { id, createdAt, organizationId, 5 more }

scim_configuration is the SCIM configuration identified by the ID

id: string

id is the unique identifier of the SCIM configuration

formatuuid
createdAt: string

created_at is when the SCIM configuration was created

formatdate-time
organizationId: string

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

formatuuid
tokenExpiresAt: string

token_expires_at is when the current SCIM token expires

formatdate-time
updatedAt: string

updated_at is when the SCIM configuration was last updated

formatdate-time
enabled: optional boolean

enabled indicates if SCIM provisioning is active

name: optional string

name is a human-readable name for the SCIM configuration

maxLength128
ssoConfigurationId: optional string

sso_configuration_id is the linked SSO configuration (optional)

formatuuid
ScimConfigurationUpdateResponse object { scimConfiguration }
scimConfiguration: ScimConfiguration { id, createdAt, organizationId, 5 more }

scim_configuration is the updated SCIM configuration

id: string

id is the unique identifier of the SCIM configuration

formatuuid
createdAt: string

created_at is when the SCIM configuration was created

formatdate-time
organizationId: string

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

formatuuid
tokenExpiresAt: string

token_expires_at is when the current SCIM token expires

formatdate-time
updatedAt: string

updated_at is when the SCIM configuration was last updated

formatdate-time
enabled: optional boolean

enabled indicates if SCIM provisioning is active

name: optional string

name is a human-readable name for the SCIM configuration

maxLength128
ssoConfigurationId: optional string

sso_configuration_id is the linked SSO configuration (optional)

formatuuid