List groups

Updated:

GET/scim/{connection_id}/groups

Parameters

filterstring
sortBystring
sortOrderstring
startIndexnumber
countnumber
connection_idstring required
ID of the connection

Returns

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]
members array
An array of members
schemas enum array
Valid values:
"urn:ietf:params:scim:schemas:core:2.0:Group"
Array of schema URIs

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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: 'GET',
  url: 'https://api.unified.to/scim/5de520f96e439b002043d8dc/groups',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    filter: '',
    sortBy: '',
    sortOrder: '',
    startIndex: '',
    count: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?