users resource

Resource that manages user accounts.

JSON request templates

Some commands in this resource generate JSON output in multiple formats, as specified by the format parameter. These output formats include different subsets of properties for the requested elements, as appropriate for different use cases. The included properties for each format are described in the JSON templates below.

name

{
  "displayName": "User Display Name",
  "id": "User ID",
  "name": "User Name"
}

list, detail

{
  "actualName": "User Actual Name",
  "authenticationRealm": "(See: authenticationRealm 
  TEMPLATE_DEFAULT)",
  "displayName": "User Display Name",
  "email": "User Email",
  "id": "User ID",
  "name": "User Name"
}

profile

{
  "actualName": "User Actual Name",
  "backupUsers": "[An ordered array of the User's Backup 
  Users.]",
  "displayName": "User Display Name",
  "email": "User Email",
  "id": "User ID",
  "name": "User Name",
  "phone": "User Phone Number",
  "profileId": "User Profile ID"
}