Update group
PUT/scim/{connection_id}/groups/{id}
Parameters
connection_idstring required
ID of the connection
idstring required
ID of the Group
Payload
idstring
The group's unique id
externalIdstring
A groups id in an external system
displayNamestring required
The group's display name
groupTypestring
Organization [NOT STANDARD]
schemas enum array
Valid values:
"urn:ietf:params:scim:schemas:core:2.0:Group"
Array of schema URIs
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | The group's unique id |
externalId | string | No | A groups id in an external system |
displayName | string | Yes | The group's display name |
groupType | string | No | Organization [NOT STANDARD] |
members | ScimGroupMember[] | No | An array of members |
members[].value | string | Yes | ID of user |
members[].$ref | string | No | url to user |
members[].display | string | No | user name |
members[].type | enum | No | NOT STANDARD Values: User, Group |
members[].operation | enum | No | ONLY USED ON UPDATES Values: add, delete |
schemas | enum | No | Array of schema URIs Values: urn:ietf:params:scim:schemas:core:2.0:Group |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'PUT',
url: 'https://api.unified.to/scim/5de520f96e439b002043d8dc/groups/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
data: undefined,
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?