GetSSOConfiguration

client.Organizations.SSOConfigurations.Get(ctx, body) (*OrganizationSSOConfigurationGetResponse, error)

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

body OrganizationSSOConfigurationGetParams

SSOConfigurationID param.Field[string]

sso_configuration_id is the ID of the SSO configuration to get

formatuuid

ReturnsExpand Collapse

type OrganizationSSOConfigurationGetResponse struct{…}

SSOConfiguration SSOConfiguration

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:

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

GetSSOConfiguration

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  ssoConfiguration, err := client.Organizations.SSOConfigurations.Get(context.TODO(), gitpod.OrganizationSSOConfigurationGetParams{
    SSOConfigurationID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", ssoConfiguration.SSOConfiguration)
}

{
  "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"
    ]
  }
}