curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/users \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"email": "<string>",
"tenantName": "<string>",
"metadata": {
"sub": "<string>",
"imageURL": "<string>",
"displayName": "<string>",
"userObject": {},
"inviteAccepted": true,
"registeredInIdp": true,
"preference": {},
"groups": [
"<string>"
],
"tenantRoleManagedBy": "manual",
"ssoName": "<string>",
"isPrimarySSO": true
},
"active": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"roles": [
"<string>"
],
"rolesWithResource": [
{
"roleId": "<string>",
"resourceType": "role",
"resourceId": "<string>"
}
],
"accounts": [
{
"accountId": "<string>",
"name": "<string>"
}
]
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}List all users of tenant filtered by query and showInvalidUsers. Pagination is available based on query parameters.
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/users \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"email": "<string>",
"tenantName": "<string>",
"metadata": {
"sub": "<string>",
"imageURL": "<string>",
"displayName": "<string>",
"userObject": {},
"inviteAccepted": true,
"registeredInIdp": true,
"preference": {},
"groups": [
"<string>"
],
"tenantRoleManagedBy": "manual",
"ssoName": "<string>",
"isPrimarySSO": true
},
"active": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"roles": [
"<string>"
],
"rolesWithResource": [
{
"roleId": "<string>",
"resourceType": "role",
"resourceId": "<string>"
}
],
"accounts": [
{
"accountId": "<string>",
"name": "<string>"
}
]
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Number of items per page
1 <= x <= 100010
Number of items to skip
x >= 00
Show Deactivated users
Include virtual accounts
Was this page helpful?