User Detail - Fetch list of all users

Retrieves a list of all users associated with any requested tenant.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Returns a list of all users for the requested tenant.

text/plainapplication/jsontext/json

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

403

Forbidden: Access denied due to insufficient permissions or account restrictions.

text/plainapplication/jsontext/json

404

Not Found: User details not found, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

Class for representing Bad Request error message.

errorMessagestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ErrorMessage property.

Default: Not found

statusCodeinteger · int32Optional

A public property of type integer that has both a getter and a setter method, which allows for getting and setting the value of the StatusCode property.

Default: 404

500

Internal Server Error: An unexpected server error occurred while processing the request.

text/plainapplication/jsontext/json

get

/userDetail

HTTPcURLJavaScriptPython

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

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "tenants": [
    {
      "tenantId": "123e4567-e89b-12d3-a456-426614174000",
      "tenantName": "text",
      "defaultThemeId": "123e4567-e89b-12d3-a456-426614174000",
      "isOwner": true,
      "groups": [
        {
          "groupId": "123e4567-e89b-12d3-a456-426614174000",
          "displayName": "text",
          "description": "text"
        }
      ]
    }
  ],
  "preferences": {
    "defaultTenant": "123e4567-e89b-12d3-a456-426614174000",
    "theme": {
      "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
    },
    "favorite": {
      "ANY_ADDITIONAL_PROPERTY": [
        "text"
      ]
    }
  }
}