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

UpdateSSOConfiguration

client.organizations.ssoConfigurations.update(SSOConfigurationUpdateParams { ssoConfigurationId, additionalScopes, claims, 8 more } body, RequestOptionsoptions?): SSOConfigurationUpdateResponse
POST/gitpod.v1.OrganizationService/UpdateSSOConfiguration

Updates SSO provider settings and authentication rules.

Use this method to:

  • Rotate client credentials
  • Update provider endpoints
  • Modify claim mappings
  • Change authentication policies
  • Toggle SSO enforcement

Examples

  • Update credentials:

    Rotates client ID and secret.

    ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
clientId: "new-client-id"
clientSecret: "new-client-secret"

  • Update provider status:

    Activates or deactivates SSO provider.

    ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
state: SSO_CONFIGURATION_STATE_ACTIVE
ParametersExpand Collapse
body: SSOConfigurationUpdateParams { ssoConfigurationId, additionalScopes, claims, 8 more }
ssoConfigurationId: string

sso_configuration_id is the ID of the SSO configuration to update

formatuuid
additionalScopes?: AdditionalScopesUpdate { scopes } | null

additional_scopes replaces the configured OIDC scopes when present. When absent (nil), scopes are left unchanged. When present with an empty scopes list, all additional scopes are cleared.

scopes?: Array<string>
claims?: Record<string, string>

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

claimsExpression?: string | null

claims_expression is a CEL expression evaluated against OIDC token claims during login. When set, the expression must evaluate to true for the login to succeed. When present with an empty string, the expression is cleared.

maxLength4096
clientId?: string | null

client_id is the client ID of the SSO provider

minLength1
clientSecret?: string | null

client_secret is the client secret of the SSO provider

minLength1
displayName?: string | null
maxLength128
emailDomain?: string | null
minLength4
emailDomains?: Array<string>
issuerUrl?: string | null

issuer_url is the URL of the IdP issuer

formaturi
state?: SSOConfigurationState | null

state is the state of the SSO configuration

One of the following:
"SSO_CONFIGURATION_STATE_UNSPECIFIED"
"SSO_CONFIGURATION_STATE_INACTIVE"
"SSO_CONFIGURATION_STATE_ACTIVE"
ReturnsExpand Collapse
SSOConfigurationUpdateResponse = unknown

UpdateSSOConfiguration

import Gitpod from '@gitpod/sdk';

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

const ssoConfiguration = await client.organizations.ssoConfigurations.update({
  ssoConfigurationId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
  clientId: 'new-client-id',
  clientSecret: 'new-client-secret',
});

console.log(ssoConfiguration);
{}
Returns Examples
{}