Skip to main content
GET
/
v1
/
users
List Users
curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "email": "john@example.com",
      "firstName": "John",
      "groups": [
        "admin-group",
        "midaz-viewer-group",
        "midaz-contributor-group"
      ],
      "id": "019c96a0-0c21-71f9-a487-66a1258278a1",
      "lastName": "Doe",
      "username": "johndoe"
    },
    {
      "email": "janedoe@example.com",
      "firstName": "Jane",
      "groups": [
        "midaz-viewer-group"
      ],
      "id": "019c96a0-6c20-7bcd-e1f2-5d6e7f8a9b0c",
      "lastName": "Doe",
      "username": "janedoe"
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 2
}

Authorizations

​
Authorization
string
header
required

The authorization token in the 'Bearer ' format.

Query Parameters

​
page
integer
default:1

The page number to retrieve.

Required range: x >= 1
​
limit
integer
default:10

The maximum number of items to return per page. Cannot exceed 100.

Required range: 1 <= x <= 100

Response

The list of all users registered in the system.

Standard paginated response wrapper.

​
items
object[]

The list of items returned for the current page.

​
page
integer

The current page number.

Example:

1

​
limit
integer

The maximum number of items returned per page.

Example:

10

​
total
integer

The total number of items available across all pages.

Example:

2