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

GetSSOConfiguration

organizations.sso_configurations.retrieve(SSOConfigurationRetrieveParams**kwargs) -> SSOConfigurationRetrieveResponse
POST/gitpod.v1.OrganizationService/GetSSOConfiguration

Retrieves a specific SSO configuration.

Use this method to:

  • View SSO provider details
  • Check configuration status
  • Verify SSO settings

Examples

  • Get SSO configuration:

    Retrieves details of a specific SSO configuration.

    ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
sso_configuration_id: str

sso_configuration_id is the ID of the SSO configuration to get

formatuuid
ReturnsExpand Collapse
class SSOConfigurationRetrieveResponse: …
sso_configuration: SSOConfiguration

sso_configuration is the SSO configuration identified by the ID

id: str

id is the unique identifier of the SSO configuration

formatuuid
issuer_url: str

issuer_url is the URL of the IdP issuer

organization_id: str
formatuuid
provider_type: 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"
additional_scopes: Optional[List[str]]

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

claims: Optional[Dict[str, str]]

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

claims_expression: Optional[str]

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
client_id: Optional[str]

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

display_name: Optional[str]
maxLength128
email_domain: Optional[str]
email_domains: Optional[List[str]]

GetSSOConfiguration

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
sso_configuration = client.organizations.sso_configurations.retrieve(
    sso_configuration_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(sso_configuration.sso_configuration)
{
  "ssoConfiguration": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "issuerUrl": "issuerUrl",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "providerType": "PROVIDER_TYPE_UNSPECIFIED",
    "state": "SSO_CONFIGURATION_STATE_UNSPECIFIED",
    "additionalScopes": [
      "string"
    ],
    "claims": {
      "foo": "string"
    },
    "claimsExpression": "claimsExpression",
    "clientId": "clientId",
    "displayName": "displayName",
    "emailDomain": "emailDomain",
    "emailDomains": [
      "sfN2.l.iJR-BU.u9JV9.a.m.o2D-4b-Jd.0Z-kX.L.n.S.f.UKbxB"
    ]
  }
}
Returns Examples
{
  "ssoConfiguration": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "issuerUrl": "issuerUrl",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "providerType": "PROVIDER_TYPE_UNSPECIFIED",
    "state": "SSO_CONFIGURATION_STATE_UNSPECIFIED",
    "additionalScopes": [
      "string"
    ],
    "claims": {
      "foo": "string"
    },
    "claimsExpression": "claimsExpression",
    "clientId": "clientId",
    "displayName": "displayName",
    "emailDomain": "emailDomain",
    "emailDomains": [
      "sfN2.l.iJR-BU.u9JV9.a.m.o2D-4b-Jd.0Z-kX.L.n.S.f.UKbxB"
    ]
  }
}