Get user by ID

Retrieves detailed information about a specific user by their ID. Requires the user.view permission.

GET /v1/users/{userId}

Get user by ID

cURL

curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/users/{userId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "user123",
  "identifiers": [
    {
      "id": "id1",
      "type": "email",
      "value": "[e-mail]",
      "verified": true,
      "created_at": "2024-01-01T00:00:00.000Z",
      "verified_at": "2024-01-01T01:00:00.000Z"
    }
  ],
  "primary_identifier": {
    "id": "id1",
    "type": "email",
    "value": "[e-mail]",
    "verified": true,
    "created_at": "2024-01-01T00:00:00.000Z",
    "verified_at": "2024-01-01T01:00:00.000Z"
  },
  "auth_methods": [
    "password"
  ],
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "roles": [
    {
      "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "name": "admin",
      "permissions": [
        "user.create",
        "user.read",
        "role.create"
      ],
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "description": "Administrator role with full access",
      "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "organization_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2794"
    }
  ],
  "first_name": "John",
  "last_name": "Doe",
  "suspended_at": "2024-01-01T00:00:00.000Z",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

JWT token for user authentication

Path Parameters

userId · string · required

User ID to retrieve

Response

200

application/json

User retrieved successfully

id · string · required

User ID

Example:

"user123"

identifiers · object[] · required

User identifiers (email/phone)

Show child attributes

primary_identifier · object · required

Show child attributes

auth_methods · enum<string>[] · required

Available authentication methods

Available options: password, google, client_platform

Example:

["password"]

created_at · string<date-time> · required

User creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

updated_at · string<date-time> · required

User last update timestamp

Example:

"2024-01-01T00:00:00.000Z"

roles · object[]

User roles

Show child attributes

first_name · string

User first name

Example:

"John"

last_name · string

User last name

Example:

"Doe"

suspended_at · string<date-time>

User suspension timestamp

Example:

"2024-01-01T00:00:00.000Z"

metadata · object

Additional user metadata