Listar usuários
Lista os usuários que o chamador alcança: a plataforma inteira para um master, a carteira (os usuários da revenda e dos clientes dela) para um administrador de revenda, e o próprio cliente para um administrador de cliente. Os filtros tenant_id, dealer_id, role e search estreitam dentro do alcance: um cliente fora do alcance responde 404 TENANT_NOT_FOUND, igual a um que não existe, e uma revenda inexistente, excluída ou fora do alcance responde 404 DEALER_NOT_FOUND, em qualquer alcance. Com os dois, o cliente precisa ser da revenda pedida; um de outra revenda responde 404 TENANT_NOT_FOUND. Por padrão traz só os ativos; include_inactive inclui os desativados. Cada linha diz se o usuário tem um token pessoal ativo, para avisar antes de uma desativação parar uma integração.
Autorização
bearer users:readCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: users:read
Parâmetros de consulta
Estreita para um cliente (dentro do alcance).
int64Estreita para uma revenda (só faz sentido no alcance de plataforma).
int64Estreita para um papel.
Valor em
- "master"
- "dealer_admin"
- "dealer_user"
- "tenant_admin"
- "tenant_user"
Busca por nome de usuário, e-mail ou nome completo.
Inclui usuários inativos (por padrão só os ativos).
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/users"{ "data": [ { "created_at": "2019-08-24T14:15:22Z", "dealer_id": 0, "email": "string", "full_name": "string", "has_active_oauth_grant": true, "has_active_token": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_active": true, "last_login_at": "2019-08-24T14:15:22Z", "role": "master", "tenant_id": 0, "username": "string" } ], "page": { "has_more": true, "next_cursor": "string" }}