You're reading "Content Management API"

SSO Settings

Represents the Single Sign-on settings of the current DatoCMS project

The SSO Settings object

A SSO Settings object is returned as part of the response body of each successful Retrieve SSO Settings or Update SSO Settings API call. The following table contains the list of all its fields along with their type, description and example values.

Object fields:
idp_saml_metadata_urlstring

URL of Identity Provider SAML Metadata endpoint

This attribute is required
saml_tokenstring

DatoCMS SAML Token

This attribute is required
scim_api_tokenstring

Security token required by Identity Providers

This attribute is required

Retrieve SSO Settings

To retrieve sso settings, send a GET request to the /sso-settings endpoint. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.

GET https://site-api.datocms.com/sso-settings HTTP/1.1
X-Api-Version3
AuthorizationBearer YOUR-API-KEY
Acceptapplication/json
HTTP Response
HTTP/1.1 200 OK
Content-Typeapplication/json; charset=utf-8
Cache-Controlcache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit30
X-RateLimit-Remaining28
{ "data": { "type": "sso_settings", "id": "312", "attributes": { "idp_saml_metadata_url": "https://my-org.oktapreview.com/app/XXXX/sso/saml/metadata", "saml_token": "a2a24ae5fbb2d955b1b4fa73f2dd58", "scim_api_token": "3d32bde700a93a79088db34a0xxx60" }, "relationships": { "default_role": { "data": { "type": "role", "id": "34" } } } } }

Update SSO Settings

To update sso settings, send a PUT request to the /sso-settings endpoint, passing the resource arguments in the request body. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.

PUT https://site-api.datocms.com/sso-settings HTTP/1.1
X-Api-Version3
AuthorizationBearer YOUR-API-KEY
Acceptapplication/json
Content-Typeapplication/json
{ "data": { "type": "sso_settings", "id": "312", "attributes": { "idp_saml_metadata_url": "https://my-org.oktapreview.com/app/XXXX/sso/saml/metadata" }, "relationships": { "default_role": { "data": { "type": "role", "id": "34" } } } } }
HTTP Response
HTTP/1.1 200 OK
Content-Typeapplication/json; charset=utf-8
Cache-Controlcache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit30
X-RateLimit-Remaining28
{ "data": { "type": "sso_settings", "id": "312", "attributes": { "idp_saml_metadata_url": "https://my-org.oktapreview.com/app/XXXX/sso/saml/metadata", "saml_token": "a2a24ae5fbb2d955b1b4fa73f2dd58", "scim_api_token": "3d32bde700a93a79088db34a0xxx60" }, "relationships": { "default_role": { "data": { "type": "role", "id": "34" } } } } }
Go ahead to: Single Sign-On user