Skip to main content
GET
/
api
/
v1
/
users
/
{cpf}
Get user by CPF
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/users/{cpf} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "cpf": "12345678901",
  "display_name": "João Silva",
  "groups": [
    "engineering_team:backend",
    "data_analysts:read"
  ],
  "roles": [
    "superadmin",
    "data-analyst"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
cpf
string
required

Response

User information retrieved successfully

Response model for user information.

​
id
integer
required

Unique identifier for the user

Example:

1

​
cpf
string
required

User's CPF (Cadastro de Pessoa Física) - Brazilian tax ID

Example:

"12345678901"

​
display_name
string | null

User's display name from JWT token (name, given_name, or email)

Example:

"João Silva"

​
groups
string[]

List of groups the user belongs to

Example:
[
  "engineering_team:backend",
  "data_analysts:read"
]
​
roles
string[]

List of roles assigned to the user (both direct and through groups)

Example:
["superadmin", "data-analyst"]