API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Scim Configurations

CreateSCIMConfiguration

client.organizations.scimConfigurations.create(ScimConfigurationCreateParams { organizationId, ssoConfigurationId, allowUnverifiedEmailAccountLinking, 2 more } body, RequestOptionsoptions?): ScimConfigurationCreateResponse { token, scimConfiguration, tokenExpiresAt }

POST/gitpod.v1.OrganizationService/CreateSCIMConfiguration

DeleteSCIMConfiguration

client.organizations.scimConfigurations.delete(ScimConfigurationDeleteParams { scimConfigurationId } body, RequestOptionsoptions?): ScimConfigurationDeleteResponse

POST/gitpod.v1.OrganizationService/DeleteSCIMConfiguration

ListSCIMConfigurations

client.organizations.scimConfigurations.list(ScimConfigurationListParams { token, pageSize, pagination } params, RequestOptionsoptions?): ScimConfigurationsPage<ScimConfiguration { id, createdAt, organizationId, 6 more } >

POST/gitpod.v1.OrganizationService/ListSCIMConfigurations

RegenerateSCIMToken

client.organizations.scimConfigurations.regenerateToken(ScimConfigurationRegenerateTokenParams { scimConfigurationId, tokenExpiresIn } body, RequestOptionsoptions?): ScimConfigurationRegenerateTokenResponse { token, tokenExpiresAt }

POST/gitpod.v1.OrganizationService/RegenerateSCIMToken

GetSCIMConfiguration

client.organizations.scimConfigurations.retrieve(ScimConfigurationRetrieveParams { scimConfigurationId } body, RequestOptionsoptions?): ScimConfigurationRetrieveResponse { scimConfiguration }

POST/gitpod.v1.OrganizationService/GetSCIMConfiguration

UpdateSCIMConfiguration

client.organizations.scimConfigurations.update(ScimConfigurationUpdateParams { scimConfigurationId, allowUnverifiedEmailAccountLinking, enabled, 2 more } body, RequestOptionsoptions?): ScimConfigurationUpdateResponse { scimConfiguration }

POST/gitpod.v1.OrganizationService/UpdateSCIMConfiguration

ModelsExpand Collapse

ScimConfiguration { id, createdAt, organizationId, 6 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

allowUnverifiedEmailAccountLinking?: boolean

allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified

enabled?: boolean

enabled indicates if SCIM provisioning is active

name?: string

name is a human-readable name for the SCIM configuration

maxLength128

ssoConfigurationId?: string

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

ScimConfigurationCreateResponse { 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, 6 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

allowUnverifiedEmailAccountLinking?: boolean

allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified

enabled?: boolean

enabled indicates if SCIM provisioning is active

name?: string

name is a human-readable name for the SCIM configuration

maxLength128

ssoConfigurationId?: 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 { 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 { scimConfiguration }

scimConfiguration: ScimConfiguration { id, createdAt, organizationId, 6 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

allowUnverifiedEmailAccountLinking?: boolean

allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified

enabled?: boolean

enabled indicates if SCIM provisioning is active

name?: string

name is a human-readable name for the SCIM configuration

maxLength128

ssoConfigurationId?: string

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

ScimConfigurationUpdateResponse { scimConfiguration }

scimConfiguration: ScimConfiguration { id, createdAt, organizationId, 6 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

allowUnverifiedEmailAccountLinking?: boolean

allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified

enabled?: boolean

enabled indicates if SCIM provisioning is active

name?: string

name is a human-readable name for the SCIM configuration

maxLength128

ssoConfigurationId?: string

sso_configuration_id is the linked SSO configuration (optional)

formatuuid