Skip to main content
GET
/
tenant
/
{tenant_name}
/
users
Get tenant user or all tenant users
curl --request GET \
  --url https://api.example.com/tenant/{tenant_name}/users \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "username": "<string>",
  "email": "<string>",
  "enabled": true,
  "password_is_expired": true,
  "remaining_failed_attempts": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "description": "<string>",
  "role": "admin",
  "is_remote_user": false,
  "user_groups": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

tenant_name
string
required

Query Parameters

username
string | null

Response

Successful Response

id
string
required
username
string
required
email
string
required
enabled
boolean
required
password_is_expired
boolean
required
remaining_failed_attempts
integer
required
first_name
string | null
last_name
string | null
phone
string | null
description
string | null
role
enum<string> | null
Available options:
admin,
viewer,
editor,
remote_user,
partner
is_remote_user
boolean
default:false
user_groups
string[] | null