API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

SSO Configurations

CreateSSOConfiguration

client.organizations.ssoConfigurations.create(SSOConfigurationCreateParams { clientId, clientSecret, issuerUrl, 6 more } body, RequestOptionsoptions?): SSOConfigurationCreateResponse { ssoConfiguration }

POST/gitpod.v1.OrganizationService/CreateSSOConfiguration

DeleteSSOConfiguration

client.organizations.ssoConfigurations.delete(SSOConfigurationDeleteParams { ssoConfigurationId } body, RequestOptionsoptions?): SSOConfigurationDeleteResponse

POST/gitpod.v1.OrganizationService/DeleteSSOConfiguration

ListSSOConfigurations

client.organizations.ssoConfigurations.list(SSOConfigurationListParams { organizationId, token, pageSize, pagination } params, RequestOptionsoptions?): SSOConfigurationsPage<SSOConfiguration { id, issuerUrl, organizationId, 9 more } >

POST/gitpod.v1.OrganizationService/ListSSOConfigurations

GetSSOConfiguration

client.organizations.ssoConfigurations.retrieve(SSOConfigurationRetrieveParams { ssoConfigurationId } body, RequestOptionsoptions?): SSOConfigurationRetrieveResponse { ssoConfiguration }

POST/gitpod.v1.OrganizationService/GetSSOConfiguration

UpdateSSOConfiguration

client.organizations.ssoConfigurations.update(SSOConfigurationUpdateParams { ssoConfigurationId, additionalScopes, claims, 8 more } body, RequestOptionsoptions?): SSOConfigurationUpdateResponse

POST/gitpod.v1.OrganizationService/UpdateSSOConfiguration

ModelsExpand Collapse

AdditionalScopesUpdate { scopes }

AdditionalScopesUpdate wraps a list of OIDC scopes so that the update request can distinguish “not changing scopes” (field absent) from “clearing all scopes” (field present, empty list).

scopes?: Array<string>

ProviderType = "PROVIDER_TYPE_UNSPECIFIED" | "PROVIDER_TYPE_BUILTIN" | "PROVIDER_TYPE_CUSTOM"

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

SSOConfiguration { id, issuerUrl, organizationId, 9 more }

id: string

id is the unique identifier of the SSO configuration

formatuuid

issuerUrl: string

issuer_url is the URL of the IdP issuer

organizationId: string

formatuuid

providerType: ProviderType

provider_type defines the type of the SSO configuration

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

state: SSOConfigurationState

state is the state of the SSO configuration

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

additionalScopes?: Array<string>

additional_scopes are extra OIDC scopes requested from the identity provider during sign-in.

claims?: Record<string, string>

claims are key/value pairs that defines a mapping of claims issued by the IdP.

claimsExpression?: string

claims_expression is a CEL (Common Expression Language) expression evaluated against the OIDC token claims during login. When set, the expression must evaluate to true for the login to succeed. The expression has access to a claims variable containing all token claims as a map. Example: claims.email_verified && claims.email.endsWith("@example.com")

maxLength4096

clientId?: string

client_id is the client ID of the OIDC application set on the IdP

displayName?: string

maxLength128

emailDomain?: string

emailDomains?: Array<string>

SSOConfigurationState = "SSO_CONFIGURATION_STATE_UNSPECIFIED" | "SSO_CONFIGURATION_STATE_INACTIVE" | "SSO_CONFIGURATION_STATE_ACTIVE"

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

SSOConfigurationCreateResponse { ssoConfiguration }

ssoConfiguration: SSOConfiguration { id, issuerUrl, organizationId, 9 more }

sso_configuration is the created SSO configuration

id: string

id is the unique identifier of the SSO configuration

formatuuid

issuerUrl: string

issuer_url is the URL of the IdP issuer

organizationId: string

formatuuid

providerType: ProviderType

provider_type defines the type of the SSO configuration

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

state: SSOConfigurationState

state is the state of the SSO configuration

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

additionalScopes?: Array<string>

additional_scopes are extra OIDC scopes requested from the identity provider during sign-in.

claims?: Record<string, string>

claims are key/value pairs that defines a mapping of claims issued by the IdP.

claimsExpression?: string

claims_expression is a CEL (Common Expression Language) expression evaluated against the OIDC token claims during login. When set, the expression must evaluate to true for the login to succeed. The expression has access to a claims variable containing all token claims as a map. Example: claims.email_verified && claims.email.endsWith("@example.com")

maxLength4096

clientId?: string

client_id is the client ID of the OIDC application set on the IdP

displayName?: string

maxLength128

emailDomain?: string

emailDomains?: Array<string>

SSOConfigurationDeleteResponse = unknown

SSOConfigurationRetrieveResponse { ssoConfiguration }

ssoConfiguration: SSOConfiguration { id, issuerUrl, organizationId, 9 more }

sso_configuration is the SSO configuration identified by the ID

id: string

id is the unique identifier of the SSO configuration

formatuuid

issuerUrl: string

issuer_url is the URL of the IdP issuer

organizationId: string

formatuuid

providerType: ProviderType

provider_type defines the type of the SSO configuration

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

state: SSOConfigurationState

state is the state of the SSO configuration

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

additionalScopes?: Array<string>

additional_scopes are extra OIDC scopes requested from the identity provider during sign-in.

claims?: Record<string, string>

claims are key/value pairs that defines a mapping of claims issued by the IdP.

claimsExpression?: string

claims_expression is a CEL (Common Expression Language) expression evaluated against the OIDC token claims during login. When set, the expression must evaluate to true for the login to succeed. The expression has access to a claims variable containing all token claims as a map. Example: claims.email_verified && claims.email.endsWith("@example.com")

maxLength4096

clientId?: string

client_id is the client ID of the OIDC application set on the IdP

displayName?: string

maxLength128

emailDomain?: string

emailDomains?: Array<string>

SSOConfigurationUpdateResponse = unknown