ListSSOConfigurations

organizations.sso_configurations.list() -> SyncSSOConfigurationsPage[SSOConfiguration]

POST/gitpod.v1.OrganizationService/ListSSOConfigurations

Lists and filters SSO configurations for an organization.

Use this method to:

View all SSO providers
Monitor authentication status
Audit security settings
Manage provider configurations

Examples

List active configurations:

Shows all active SSO providers.

organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
pagination:
  pageSize: 20

List by provider type:

Shows custom SSO configurations.

organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
pagination:
  pageSize: 20
  token: "next-page-token-from-previous-response"

ParametersExpand Collapse

organization_id: str

organization_id is the ID of the organization to list SSO configurations for.

formatuuid

token: Optional[str]

page_size: Optional[int]

maximum100

minimum0

pagination: Optional[Pagination]

token: Optional[str]

Token for the next set of results that was returned as next_token of a PaginationResponse

page_size: Optional[int]

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

ReturnsExpand Collapse

class SSOConfiguration: …

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]]

ListSSOConfigurations

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.organizations.sso_configurations.list(
    organization_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
    pagination={
        "page_size": 20
    },
)
page = page.sso_configurations[0]
print(page.id)

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "ssoConfigurations": [
    {
      "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

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "ssoConfigurations": [
    {
      "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"
      ]
    }
  ]
}