User - Retrieves user details by ID

Retrieves details of the requested user based on the provided user ID.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

userIdstring · uuidRequired

Enter the ID of an existing user

Query parameters

includestring · enumOptional

Enum for include props.

Possible values:

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Success: Requested user retrieved successfully.

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

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

404

Not Found: The requested user does not exist in the system

text/plainapplication/jsontext/json

500

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

text/plainapplication/jsontext/json

get

/users/{userId}

HTTPcURLJavaScriptPython

GET /users/{userId} 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
        }
      ]
    }
  ]
}