Get Users of Tenant (2.0)

GET 
/v2.0/api/tenants/:tenant_id/directoryusers

Get users of a tenant.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The number of responses.

id string

The ID of the response.

tenant_id string

The ID of the tenant.

items DirectoryUser[]
Array [
description
The description of the user. Max size = 256.
id string
The user ID.
name stringrequired
The user's name.
stale boolean
Stale
tags string[]
A information field that can be added to identify the user. Maximum 10 unique tags of length 1024 each are allowed.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
user_group_ids string[]
The user group IDs to which the user belongs.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "id": "string",
      "name": "string",
      "stale": true,
      "tags": [
        "string"
      ],
      "tenant_id": "string",
      "user_group_ids": [
        "string"
      ]
    }
  ]
}

Loading...