CreateSCIMConfiguration

client.organizations.scimConfigurations.create(, ?): ScimConfigurationCreateResponse { token, scimConfiguration, tokenExpiresAt }

POST/gitpod.v1.OrganizationService/CreateSCIMConfiguration

Creates a new SCIM configuration for automated user provisioning.

Use this method to:

Set up SCIM 2.0 provisioning from an identity provider
Generate a bearer token for SCIM API authentication
Link SCIM provisioning to an existing SSO configuration

Examples

Create basic SCIM configuration:

Creates a SCIM configuration linked to an SSO provider with default 1 year token expiration.
```
organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

Create SCIM configuration with custom token expiration:

Creates a SCIM configuration with a 90-day token expiration.

organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
tokenExpiresIn: "7776000s"

ParametersExpand Collapse

body: ScimConfigurationCreateParams { organizationId, ssoConfigurationId, allowUnverifiedEmailAccountLinking, 2 more }

organizationId: string

organization_id is the ID of the organization to create the SCIM configuration for

formatuuid

ssoConfigurationId: string

sso_configuration_id is the SSO configuration to link (required for user provisioning)

formatuuid

allowUnverifiedEmailAccountLinking?: boolean | null

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

name?: string | null

name is a human-readable name for the SCIM configuration

maxLength128

tokenExpiresIn?: string | null

token_expires_in is the duration until the token expires. Defaults to 1 year. Minimum 1 day, maximum 2 years.

formatregex

ReturnsExpand Collapse

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

CreateSCIMConfiguration

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const scimConfiguration = await client.organizations.scimConfigurations.create({
  organizationId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
  ssoConfigurationId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(scimConfiguration.token);

{
  "token": "token",
  "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",
    "allowUnverifiedEmailAccountLinking": true,
    "enabled": true,
    "name": "name",
    "ssoConfigurationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "tokenExpiresAt": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "token": "token",
  "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",
    "allowUnverifiedEmailAccountLinking": true,
    "enabled": true,
    "name": "name",
    "ssoConfigurationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "tokenExpiresAt": "2019-12-27T18:11:19.117Z"
}