Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations

SSO Configurations

CreateSSOConfiguration
client.Organizations.SSOConfigurations.New(ctx, body) (*OrganizationSSOConfigurationNewResponse, error)
POST/gitpod.v1.OrganizationService/CreateSSOConfiguration
DeleteSSOConfiguration
client.Organizations.SSOConfigurations.Delete(ctx, body) (*OrganizationSSOConfigurationDeleteResponse, error)
POST/gitpod.v1.OrganizationService/DeleteSSOConfiguration
ListSSOConfigurations
client.Organizations.SSOConfigurations.List(ctx, params) (*SSOConfigurationsPage[SSOConfiguration], error)
POST/gitpod.v1.OrganizationService/ListSSOConfigurations
GetSSOConfiguration
client.Organizations.SSOConfigurations.Get(ctx, body) (*OrganizationSSOConfigurationGetResponse, error)
POST/gitpod.v1.OrganizationService/GetSSOConfiguration
UpdateSSOConfiguration
client.Organizations.SSOConfigurations.Update(ctx, body) (*OrganizationSSOConfigurationUpdateResponse, error)
POST/gitpod.v1.OrganizationService/UpdateSSOConfiguration
ModelsExpand Collapse
type AdditionalScopesUpdate struct{…}

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 []stringOptional
type ProviderType string
One of the following:
const ProviderTypeUnspecified ProviderType = "PROVIDER_TYPE_UNSPECIFIED"
const ProviderTypeBuiltin ProviderType = "PROVIDER_TYPE_BUILTIN"
const ProviderTypeCustom ProviderType = "PROVIDER_TYPE_CUSTOM"
type SSOConfiguration struct{…}
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:
const ProviderTypeUnspecified ProviderType = "PROVIDER_TYPE_UNSPECIFIED"
const ProviderTypeBuiltin ProviderType = "PROVIDER_TYPE_BUILTIN"
const ProviderTypeCustom ProviderType = "PROVIDER_TYPE_CUSTOM"
State SSOConfigurationState

state is the state of the SSO configuration

One of the following:
const SSOConfigurationStateUnspecified SSOConfigurationState = "SSO_CONFIGURATION_STATE_UNSPECIFIED"
const SSOConfigurationStateInactive SSOConfigurationState = "SSO_CONFIGURATION_STATE_INACTIVE"
const SSOConfigurationStateActive SSOConfigurationState = "SSO_CONFIGURATION_STATE_ACTIVE"
AdditionalScopes []stringOptional

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

Claims map[string, string]Optional

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

ClaimsExpression stringOptional

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 stringOptional

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

DisplayName stringOptional
maxLength128
EmailDomain stringOptional
EmailDomains []stringOptional
type SSOConfigurationState string
One of the following:
const SSOConfigurationStateUnspecified SSOConfigurationState = "SSO_CONFIGURATION_STATE_UNSPECIFIED"
const SSOConfigurationStateInactive SSOConfigurationState = "SSO_CONFIGURATION_STATE_INACTIVE"
const SSOConfigurationStateActive SSOConfigurationState = "SSO_CONFIGURATION_STATE_ACTIVE"