Skip to main content
Version: v41

user_request

A complete user object

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
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_request
    {
    "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"
    },
    "attributes": [
    {
    "key": "windows_sid",
    "value": "some_value"
    }
    ]
    }