Skip to content

Users

Operações relacionadas à consulta de usuários

Operations

Consulta informações de um usuário

Request

Consulta dados detalhados de um usuário a partir do identificador do Aut0.

Security
InternalAuth
Query
userIdstringrequired

Identificador único do usuário (ID Aut0).

Example:userId=auth0|1234567890abcdef12345678
GET
/hub-api/users
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/users?userId=auth0%7C1234567890abcdef12345678' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Usuário encontrado com sucesso

Bodyapplication/json
personobject

Informações pessoais do usuário

userobject

Informações adicionais do usuário no Aprova

Response
{
  "person": {
    "id": "auth0|1234567890abcdef12345678",
    "type": "personal",
    "document": "12345678900",
    "email": "usuario.parceiro@exemplo.com",
    "name": "Maria Oliveira",
    "phone": "11999998888",
    "address": "Rua das Flores, 100 - São Paulo/SP"
  },
  "user": {
    "role": "Analista",
    "linked_sectors": [ … ],
    "assigned_permissions": [ … ],
    "account_status": "active",
    "account_situation": { … },
    "created_at": "2025-06-01T12:00:00.000Z",
    "last_login": "2025-11-05T19:52:42.883Z",
    "last_registration_update": "2025-10-20T08:15:30.000Z",
    "redirect_to": null
  }
}