API Reference/Management/Tenants/SSO
GET
/v2/mgmt/sso/settings

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Query Parameters

tenantIdstring
ssoIdstring
curl -X GET "https://api.descope.com/v2/mgmt/sso/settings?tenantId=string&ssoId=string" \
  -H "Authorization: Bearer <token>"

OK

{
  "tenant": {
    "id": "string",
    "name": "string",
    "selfProvisioningDomains": [
      "string"
    ],
    "customAttributes": {},
    "authType": "string",
    "domains": [
      "string"
    ],
    "createdTime": 0,
    "disabled": true,
    "enforceSSO": true
  },
  "saml": {
    "idpEntityId": "string",
    "idpSSOUrl": "string",
    "idpCertificate": "string",
    "idpMetadataUrl": "string",
    "spEntityId": "string",
    "spACSUrl": "string",
    "spCertificate": "string",
    "attributeMapping": {
      "name": "string",
      "email": "string",
      "username": "string",
      "group": "string",
      "givenName": "string",
      "middleName": "string",
      "familyName": "string",
      "picture": "string",
      "customAttributes": {
        "property1": "string",
        "property2": "string"
      },
      "verifiedEmail": "string",
      "verifiedPhone": "string"
    },
    "groupsMapping": [
      {
        "role": {
          "id": "string",
          "name": "string"
        },
        "groups": [
          "string"
        ]
      }
    ],
    "redirectUrl": "string",
    "spSignCertificate": "string",
    "subjectNameIdFormat": "string",
    "defaultSSORoles": [
      "string"
    ],
    "fgaMappings": {
      "property1": {
        "relations": [
          {
            "resource": "string",
            "relationDefinition": "string",
            "namespace": "string"
          }
        ]
      },
      "property2": {
        "relations": [
          {
            "resource": "string",
            "relationDefinition": "string",
            "namespace": "string"
          }
        ]
      }
    }
  },
  "oidc": {
    "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"
  },
  "ssoId": "string"
}

Was this helpful?

SSO Management API Overview

Use the Descope API to manage your tenants' SSO configurations with a management key.

Set Tenant's SAML Settings POST

### Configure the SAML Settings, using a valid management key. This API endpoint will configure the SAML settings on a tenant utilizing a valid management key. This API endpoint accepts idpURL, entityId, idpCert, and redirectURL which will be applied to the tenant under SSO Configuration section and will select the option to "Enter the connection details manually" This endpoint also accepts the attribute mapping you would like to be configured on the SAML settings. These configurations will need to be captured directly from your idp provider. The values for each field can be obtained from the admin console of the identity provider. Alternatively, administrators can configure SAML without applying these setting manually via [Configure SAML Metadata URL](/api/management/tenants/sso/configure-sso-saml-settings-by-metadata) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`