Listar usuários

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

Obtem a lista de usuários criados no IAM


Request

paginação / link de referência
Entenda como aplicar paginação e ordenação na sua listagem
Entenda como aplicar filtros na sua listagem
Entenda como expandir entidades relacionadas nos documentos da listagem

Responses

200
Successfully retrieved API registry entry.
Field Type Description Optional Searchable minLength maxLength
name string Nome do usuário. required true 3 40
code string Código único secundário do usuário. not required false
last_name string Sobrenome do usuário. required true 3 40
email string Endereço de e‑mail único do usuário. required true 10 60
phone string Telefone de contato do usuário. not required false 10 20
language enum Idioma preferido do usuário. required false 2 10
enabled boolean Se a conta está ativada. required false
roles array(id) IDs dos papéis atribuídos ao usuário. required false
permissions array(string) Permissões específicas do usuário. required false
settings object Configurações do usuário.
requer uma key:
alert_pending_tasks: boolean - not required
not required false
groups array(id) IDs dos grupos de usuários permitidos. not required false
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

Copyright © 2025 kruzer | All Rights Reserved