User - Fetch list of all users

Fetch list of all users

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

pageNumberinteger · int32Optional

Expects number for the page, default is 1

pageSizeinteger · int32Optional

Expects size of the page, default is 100

tenantIdstring · uuidOptional

Expects an optional Id of an existing tenant

roleIdstring · uuidOptional

Expects an optional Id of an existing role

assetIdstring · uuidOptional

Expects an optional Id of an existing asset of a tenant

includestring · enumOptional

Enum for include props.

Possible values:

orderBystring · enumOptional

Enum for order by props.

Possible values:

orderstring · enumOptional

Enum for order props.

Possible values:

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Successful retrieval of users

text/plainapplication/jsontext/json

Class for representing the view of user detail.

userIdstring · uuid · nullableOptional

A public property of type nullable Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the userId property.

401

Un-authorized request

text/plainapplication/jsontext/json

500

Server related error

text/plainapplication/jsontext/json

get

/users

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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
          }
        ]
      }
    ]
  }
]