Set Tenant's SAML Settings via Metadata URL | API Reference | Descope Documentation

API ReferenceManagementTenants SSO

POST

/v1/mgmt/sso/saml/metadata

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

tenantId?string

settings?object

redirectUrl?string

domains?array<string>

string

ssoId?string

Configure the SAML Metadata URL, using a valid management key.

This API endpoint will configure the SAML Metadata URL on a tenant utilizing a valid management key.

This API endpoint accepts idpMetadataURL which will be applied to the tenant under SSO Configuration section and will select the option to "Retrieve the connection details dynamically using a metadata URL"

This endpoint also accepts the attribute mapping you would like to be configured on the SAML settings.

This Metadata URL can can be obtained from the admin console of the identity provider. Configuring SAML via Metadata URL allows administrators to configure SAML without applying these setting manually via Configure SAML Settings

See also

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

curl -X POST "https://api.descope.com/v1/mgmt/sso/saml/metadata" \  -H "Content-Type: application/json" \  -d '{}'

Was this helpful?

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.

Set Tenant's OIDC Settings POST

### 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](/sso) for further details on managing SSO Configurations on a tenant.