You're reading "Content Management API"

Single Sign-On group

A Single Sign-On group exists when a DatoCMS project is connected to an Identity Provider. These groups can be used to link DatoCMS roles to the Identity Provider's groups.

The Single Sign-On group object

A Single Sign-On group object is returned as part of the response body of each successful List all SSO groups, Update a SSO group or Delete a group API call. The following table contains the list of all its fields along with their type, description and example values.

Object fields:
namestring

Name of the group

This attribute is required
priorityinteger

When an user belongs to multiple groups, the role associated to the group with the highest priority will be used

This attribute is required

List all SSO groups

To list all sso groups, send a GET request to the /sso-groups 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-groups 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_group", "id": "312", "attributes": { "name": "Admin", "priority": 1 }, "relationships": { "role": { "data": { "type": "role", "id": "34" } }, "users": { "data": [ { "type": "sso_user", "id": "312" } ] } } } ] }

Update a SSO group

To update a sso group, send a PUT request to the /sso-groups/:sso_group_id 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-groups/:sso_group_id HTTP/1.1
X-Api-Version3
AuthorizationBearer YOUR-API-KEY
Acceptapplication/json
Content-Typeapplication/json
{ "data": { "type": "sso_group", "id": "312", "attributes": { "priority": 1 }, "relationships": { "role": { "data": { "type": "role", "id": "34" } }, "users": { "data": [ { "type": "sso_user", "id": "312" } ] } } } }
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_group", "id": "312", "attributes": { "name": "Admin", "priority": 1 }, "relationships": { "role": { "data": { "type": "role", "id": "34" } }, "users": { "data": [ { "type": "sso_user", "id": "312" } ] } } } }

Delete a group

To delete a group, send a DELETE request to the /sso-groups/:sso_group_id 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.

DELETE https://site-api.datocms.com/sso-groups/:sso_group_id 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_group", "id": "312", "attributes": { "name": "Admin", "priority": 1 }, "relationships": { "role": { "data": { "type": "role", "id": "34" } }, "users": { "data": [ { "type": "sso_user", "id": "312" } ] } } } }
Go ahead to: Job result