Obter todos os Users Groups

GET https://.account-name.krzlabs.io/api/v1/users-groups

Realiza a leitura de todos os users groups.

---

Request

paginação / link de referência

Entenda como aplicar paginação e ordenação na sua listagem

filtros / link de referência

Entenda como aplicar filtros na sua listagem

expansão / link de referência

Entenda como expandir entidades relacionadas nos documentos da listagem

---

Responses

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
source_id	string	Identificador da origem da permissão.	required	false
name	string	Nome da permissão.	required	true
description	string	Descrição da permissão.	not required	true
has_full_product_access	boolean	Indica se há acesso total aos produtos.	not required	false
users	array	Lista de usuários vinculados à permissão.	required	false

estrutura users

Field	Type	Description	Optional	Searchable
id	id	Identificador do usuário.	not required	false
name	string	Nome do usuário.	not required	false
roles	array<string>	Lista de papéis atribuídos ao usuário.	not required	false

Exemplo em JSON

{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "source_id": "PERM_SRC_001",
        "name": "Gerenciar Produtos",
        "description": "Permissão que concede acesso para gerenciar todos os produtos.",
        "has_full_product_access": true,
        "users": [
          {
            "id": "64f1b3d4e5d987654321cdef",
            "name": "Mateus Martins",
            "roles": ["admin", "editor"]
          }
        ]
    }]
}

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema