GET | Retrieve all groups

Prev Next

Endpoint: GET {{senhasegura_url}}/iso/scim/v2/Groups

Description: retrieves a comprehensive list of all groups available within the senhasegura platform, including group metadata and member associations.

Request Parameters

  • Method: GET.
  • Content-Type: application/json.
  • Authorization: Bearer token required.

Response Structure

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": number,
  "startIndex": number,
  "itemsPerPage": number,
  "Resources": [
    {
      "id": "string",
      "displayName": "string",
      "members": [
        {
          "type": "User",
          "value": "string",
          "primary": boolean
        }
      ]
    }
  ]
}

Response Elements

Element Description
schemas SCIM schema identifier for list response format.
totalResults Total number of groups in the system.
startIndex Starting index for pagination.
itemsPerPage Number of items returned per page.
Resources Array containing group objects with associated member data.

Status Codes

Status Code Description
200 OK Successful retrieval of the group list.
401 Unauthorized Invalid or missing authentication token.
403 Forbidden Insufficient permissions to access groups.