List Users

Returns your organization’s users, one page at a time, each with the groups it belongs to and its MFA status.

Called whenever the user list is shown, and after any create or delete to refresh it. name, roleId and groupId narrow the page; they combine, and an empty value is ignored.

Read-only: nothing changes. Only users of the organization resolved from your token are ever returned; there is no parameter that widens that.

⚠️ mfa is TRI-STATE on this route and the null is meaningful: it means the per-user MFA read did not complete, NOT that the member has no MFA. Render it as unknown. The single-user read (GET /v1/users/{id}) always resolves it.

Failures:

• 400 IDE-0018 — limit is above the deployment’s maximum (100 by default).
• 400 IDE-0019 — page is below 1.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

GET /v1/users

List Users

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/users \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "countryCode": "BR",
      "email": "[e-mail]",
      "firstName": "John",
      "groups": [
        "<string>"
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastName": "Doe",
      "mfa": {
        "emailEnabled": false,
        "enabled": true,
        "methods": [
          "app",
          "email"
        ],
        "preferredType": "app",
        "totpEnabled": true
      },
      "phone": "[phone]",
      "username": "johndoe"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 10
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

page · integer<int64> · default: 1

Page number.

Example:

1

limit · integer<int64> · default: 10

Items per page.

Example:

10

name · string

Filter by name (case-insensitive substring).

roleId · string

Filter by role ID (relational listing).

groupId · string

Filter by group ID (relational listing).

Response

200

application/json

OK

items · object[]

The page of users.

Show child attributes

limit · integer<int64>

The page size that was applied.

Example:

10

page · integer<int64>

The 1-based page this response corresponds to.

Example:

1

total · integer<int64>

Total number of users, across all pages.

Example:

10