User - Retrieves a list of users with filters

Retrieves a list of users based on optional parameters such as page number, page size, tenant ID, role ID, and asset ID.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

pageNumberinteger · int32Optional

Enter the page number you want to fetch. Default is 1.

pageSizeinteger · int32Optional

Enter the number of users per page. Default is 100.

tenantIdstring · uuidOptional

Optional. ID of a specific tenant.

roleIdstring · uuidOptional

Optional. ID of a specific role.

assetIdstring · uuidOptional

Optional. ID of a specific asset belonging to 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

Success: Users retrieved successfully.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

/users

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Host: 
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
          }
        ]
      }
    ]
  }
]