Tenant - Retrieves users for a tenant

Retrieves a list of all users who are part of a specified tenant.

get

/tenants/{tenantId}/users

Authorizations

Path parameters

tenantIdstring uuidrequired

Enter the ID of an existing tenant.

Query parameters

pageNumberinteger int32

Enter the page number (default is 1).

pageSizeinteger int32

Enter the page size (default is 100).

includeenum

Enum for include props.

Options: tenants, roles, none

orderByenum

Enum for order by props.

Options: TenantName, RoleName, UserId

orderenum

Enum for order props.

Options: ASC, DESC

versionstring

The requested API version

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tenants/{tenantId}/users' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

[
  {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "tenants": [
      {
        "tenantId": "123e4567-e89b-12d3-a456-426614174000",
        "tenantName": "text",
        "isOwner": true,
        "tenantLevelRole": "text",
        "assets": [
          {
            "assetId": "123e4567-e89b-12d3-a456-426614174000",
            "assetName": "text",
            "assetType": "text",
            "rlsRole": [
              "text"
            ],
            "roleId": "123e4567-e89b-12d3-a456-426614174000",
            "roleName": "text",
            "canCreate": true,
            "canEdit": true,
            "canExport": true,
            "canView": true
          }
        ]
      }
    ]
  }
]

Success: Users retrieved successfully for the requested tenant.