Sorry, no results found for "".

Show examples in:
Javascript HTTP
Endpoint info
Available examples

Content Management API > SSO Group

Update a SSO group

Body parameters

type string Required

Must be exactly "sso_group".

attributes.priority integer Required

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

Example: 1
relationships.role.data Required

Sso Group's role

Returns

Returns a resource object of type sso_group.

Examples

PUT https://site-api.datocms.com/sso-groups/:sso_group_id HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Content-Type: application/vnd.api+json
{
"data": {
"type": "sso_group",
"id": "312",
"attributes": {
"priority": 1
},
"relationships": {
"role": {
"data": {
"type": "role",
"id": "34"
}
}
}
}
}
Terminal window
curl -g 'https://site-api.datocms.com/sso-groups/:sso_group_id' \
-X PUT \
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3" \
-H "Content-Type: application/vnd.api+json" \
--data-binary '{"data":{"type":"sso_group","id":"312","attributes":{"priority":1},"relationships":{"role":{"data":{"type":"role","id":"34"}}}}}'
await fetch("https://site-api.datocms.com/sso-groups/:sso_group_id", {
method: "PUT",
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
"Content-Type": "application/vnd.api+json",
},
body: JSON.stringify({
data: {
type: "sso_group",
id: "312",
attributes: { priority: 1 },
relationships: { role: { data: { type: "role", id: "34" } } },
},
}),
});
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"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"
}
]
}
}
}
}