GET
/
api
/
svc
/
v1
/
users
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "userName": "<string>",
      "tenantName": "<string>",
      "metadata": {
        "sub": "<string>",
        "imageURL": "<string>",
        "displayName": "<string>",
        "userObject": {},
        "inviteAccepted": true,
        "registeredInIdp": true,
        "preference": {}
      },
      "roles": [
        "<string>"
      ],
      "active": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
query
string
​
showInvalidUsers
boolean

Show Deactivated users

Response

200 - application/json

Returns all users of tenant and also the response includes paginated data.

The response is of type object.

GET
/
api
/
svc
/
v1
/
users
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "userName": "<string>",
      "tenantName": "<string>",
      "metadata": {
        "sub": "<string>",
        "imageURL": "<string>",
        "displayName": "<string>",
        "userObject": {},
        "inviteAccepted": true,
        "registeredInIdp": true,
        "preference": {}
      },
      "roles": [
        "<string>"
      ],
      "active": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
query
string
​
showInvalidUsers
boolean

Show Deactivated users

Response

200 - application/json

Returns all users of tenant and also the response includes paginated data.

The response is of type object.