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

GetSCIMConfiguration

client.organizations.scimConfigurations.retrieve(ScimConfigurationRetrieveParams { scimConfigurationId } body, RequestOptionsoptions?): ScimConfigurationRetrieveResponse { scimConfiguration }
POST/gitpod.v1.OrganizationService/GetSCIMConfiguration

Retrieves a specific SCIM configuration.

Use this method to:

  • View SCIM configuration details
  • Check if SCIM is enabled
  • Verify SSO linkage

Examples

  • Get SCIM configuration:

    Retrieves details of a specific SCIM configuration.

    scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
body: ScimConfigurationRetrieveParams { scimConfigurationId }
scimConfigurationId: string

scim_configuration_id is the ID of the SCIM configuration to get

formatuuid
ReturnsExpand Collapse
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

GetSCIMConfiguration

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.retrieve({
  scimConfigurationId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(scimConfiguration.scimConfiguration);
{
  "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"
  }
}
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",
    "allowUnverifiedEmailAccountLinking": true,
    "enabled": true,
    "name": "name",
    "ssoConfigurationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}