API ReferenceManagementTenantsSSO
POST
/v1/mgmt/sso/oidc

Configure the OIDC settings of a tenant, using a valid management key.

This API endpoint will configure the OIDC settings on a tenant utilizing a valid management key.

This endpoint accepts the OIDC configuration settings as well as the attribute mapping you would like to be configured on the SAML settings.

See also

  • See SSO Configuration for further details on managing SSO Configurations on a tenant.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/sso/oidc

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

tenantIdstring

settingsobject

domainsarray<string>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/sso/oidc" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "tenantId": "string",
  "settings": {
    "name": "string",
    "clientId": "string",
    "clientSecret": "string",
    "redirectUrl": "string",
    "authUrl": "string",
    "tokenUrl": "string",
    "userDataUrl": "string",
    "scope": [
      "string"
    ],
    "JWKsUrl": "string",
    "userAttrMapping": {
      "loginId": "string",
      "username": "string",
      "name": "string",
      "email": "string",
      "verifiedEmail": "string",
      "verifiedPhone": "string",
      "picture": "string",
      "givenName": "string",
      "middleName": "string",
      "familyName": "string",
      "customAttributes": {
        "property1": "string",
        "property2": "string"
      }
    },
    "manageProviderTokens": true,
    "callbackDomain": "string",
    "prompt": [
      "string"
    ],
    "grantType": "string",
    "issuer": "string"
  },
  "domains": [
    "string"
  ]
}'
Was this helpful?

Previous

Set Tenant's SAML Settings via Metadata URL

Next

Delete Tenant's SAML/OIDC Settings