Content Management API > SSO Settings

Update SSO Settings

Body parameters

type string Required

Must be exactly "sso_settings".

attributes.idp_saml_metadata_url null, string Optional

URL of Identity Provider SAML Metadata endpoint

Example:

"https://my-org.oktapreview.com/app/XXXX/sso/saml/metadata"

attributes.idp_saml_metadata_xml null, string Optional

Identity Provider SAML Metadata

Example:

'<?xml version="1.0" encoding="UTF-8"?>...'

relationships.default_role.data Optional

The default role assigned to SSO users that do not belong to any SSO group

Type: ResourceLinkage<"role">

Returns

Returns a resource object of type sso_settings.

Examples

1
PUT https://site-api.datocms.com/sso-settings HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "type": "sso_settings"
10
  }
11
}

1
curl -g 'https://site-api.datocms.com/sso-settings' \
2
  -X PUT \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"type":"sso_settings"}}'

1
await fetch("https://site-api.datocms.com/sso-settings", {
2
  method: "PUT",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
    "Content-Type": "application/vnd.api+json",
8
  },
9
  body: JSON.stringify({ data: { type: "sso_settings" } }),
10
});

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "sso_settings",
10
    "id": "312",
11
    "attributes": {
12
      "idp_saml_metadata_url": "https://my-org.oktapreview.com/app/XXXX/sso/saml/metadata",
13
      "scim_base_url": "https://sso.datocms.com/scim",
14
      "saml_acs_url": "https://sso.datocms.com/XXX/saml/consume",
15
      "sp_saml_metadata_url": "https://sso.datocms.com/XXX/saml/metadata",
16
      "sp_saml_base_url": "https://sso.datocms.com/XXX/saml",
17
      "saml_token": "a2a24ae5fbb2d955b1b4fa73f2dd58"
18
    },
19
    "relationships": {
20
      "default_role": {
21
        "data": null
22
      }
23
    }
24
  }
25
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.