Skip to main content

GET Listar Usuários de um Role

Lista os usuários do Auth0 vinculados a um role.

Autenticação necessária

Esta rota requer o header Authorization: Bearer {accessToken}

Permissão necessária

Exige a permissão give_roles.

Sem paginação

A rota pagina internamente pelas páginas do Auth0 e retorna a lista completa de uma vez (até 100 por página, seguindo automaticamente para as próximas).

Endpoint​

GET https://api-dev.imagemais.com.br/api/auth/roles/{id}/users

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idstring✅ID do role no Auth0

Requisição​

curl -X 'GET' \
  'https://api-dev.imagemais.com.br/api/auth/roles/rol_NpZ4mK9vQsTr2LxW/users' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

[
  {
    "user_id": "auth0|6a579131661195ece569af724",
    "name": "Ana Souza",
    "email": "ana.souza@imagemais.com.br"
  }
]

404 Role não existe​

Erro cru do SDK do Auth0

Diferente das outras rotas da API, este erro não passa pelo formato padrão do Nest (error/statusCode limpos) — é o objeto de erro do SDK do Auth0 serializado como veio, incluindo o Body aninhado como string.

{
  "statusCode": 404,
  "message": "NotFoundError\nStatus code: 404\nBody: {\n  \"statusCode\": 404,\n  \"error\": \"Not Found\",\n  \"message\": \"The role does not exist.\"\n}"
}

400 ID com formato inválido​

Retornado quando id não bate com o formato esperado pelo Auth0 (rol_ + identificador hexadecimal).

{
  "statusCode": 400,
  "message": "BadRequestError\nStatus code: 400\nBody: {\n  \"statusCode\": 400,\n  \"error\": \"Bad Request\",\n  \"message\": \"Path validation error: 'Object didn't pass validation for format role-id: {id}' on property id (ID of the role to retrieve a list of users associated with).\",\n  \"errorCode\": \"invalid_uri\"\n}"
}