List the user directory

GET

/api/v1/users

GET

/api/v1/users

Authorization

bearerAuth users.directory.read

headerAuthorizationBearer <API key or OAuth 2.1 access token>

Send Authorization: Bearer <credential>. Create API keys in AirTrail Security settings. OAuth clients use authorization code with PKCE S256 and a resource identifier matching /api/v1.

Scope: users.directory.read

Response Body

Visible users.

application/json

response

data*array<>

Example Request

curl -X GET 'https://your-instance.example/api/v1/users'

Example Request

curl -X GET 'https://your-instance.example/api/v1/users'

Example ResponseSchema

{
  "data": [
    {
      "canManage": true,
      "roleId": "string",
      "roleName": "string",
      "isOwner": true,
      "id": "string",
      "username": "string",
      "displayName": "string"
    }
  ]
}

{  "data": [    {      "canManage": true,      "roleId": "string",      "roleName": "string",      "isOwner": true,      "id": "string",      "username": "string",      "displayName": "string"    }  ]}

List the user directory

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body