user

A complete user object

idstring<uuid>

A unique identifier for the user

createdstring<date-time>

When the object was created

Example: 2017-01-01T15:05:05Z

updatedstring<date-time>

When the object was created

Example: 2017-01-01T15:05:05Z

updated_bystring<uuid>

ID of the user who updated the object

Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059

authorstring<uuid>

ID of the user who originally authored the object

Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059

commentstring

A comment describing the object

Example: A comment

tagsstring[]

Array of tag strings

usernamestringrequired

A unique principal name for the user, a username or an email address

windows_accountstring

Windows account name

unix_accountstring

Unix account name

full_namestring

Full name

display_namestring

Display name

job_titlestring

Job title

companystring

Company

departmentstring

Department

emailstring

Email address

telephonestring

Phone number

localestring

User's locale. Language code ISO 639-1 & country code ISO 3166-1 separated by a "_"

Example: fi_FI

password object

passwordstring<password>required

Password

createdstring<date-time>

When the password was created

Example: 2017-01-01T15:05:05Z

password_change_requiredboolean

Password change required

attributes object[]

a list of user attributes in key/value string format

Array [

keystring

the name of the user attribute

Example: windows_sid

valuestring

the value of the user attribute

Example: some_value

]

user

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "username": "string",
  "windows_account": "string",
  "unix_account": "string",
  "full_name": "string",
  "display_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "password": {
    "password": "string",
    "created": "2017-01-01T15:05:05Z"
  },
  "password_change_required": true,
  "attributes": [
    {
      "key": "windows_sid",
      "value": "some_value"
    }
  ]
}