GET | Recuperar todos os grupos

Prev Next

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

Descrição: Recupera uma lista abrangente de todos os grupos disponíveis na plataforma senhasegura, incluindo metadados dos grupos e associações de membros.

Parâmetros da Requisição

  • Método: GET.
  • Content-Type: application/json.
  • Authorization: Token Bearer obrigatório.

Estrutura da Resposta

{
  "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
        }
      ]
    }
  ]
}

Elementos da Resposta

Elemento Descrição
schemas Identificador do schema SCIM para formato de resposta de lista.
totalResults Número total de grupos no sistema.
startIndex Índice inicial para paginação.
itemsPerPage Número de itens retornados por página.
Resources Array contendo objetos de grupo com dados de membros associados.

Códigos de Status

Código de Status Descrição
200 OK Recuperação bem-sucedida da lista de grupos.
401 Unauthorized Token de autenticação inválido ou ausente.
403 Forbidden Permissões insuficientes para acessar os grupos.