REST API

User

Updated: December 19, 2019

This page is scheduled for review and update. Check back soon for updated content!

Representation of a User.

Resource Representation

{
  "entity-type": "user",
  "id": string,
  "properties": object,
  "extendedGroups": [
    {
      "name": string,
      "label": string,
      "url": string
    }
  ],
  "isAdministrator": boolean,
  "isAnonymous": boolean,
  "contextParameters": object
}
Property Name Value Description Notes
entity-type string The entity type name. Value: the fixed string "user".
id string The user id.
properties object A collection of key-value pairs of user properties.
extendedGroups[] list The list of user groups.
extendedGroups[].name string The group name.
extendedGroups[].label string The group label.
extendedGroups[].url string The group resource URL.
isAdministrator boolean Whether the user is an administrator.
isAnonymous boolean Whether the user is anonymous.
contextParameters object A collection of key-value pairs filled by enabled enrichers. Optional

We'd love to hear your thoughts!

All fields required