user.md

description
A user resource contains profile and workflow details for a user.

User

A user resource contains profile and workflow details for a user. Extended profile properties for a user can be specified in the custom field

Properties

Name	Type	Format	Description
id	string	GUID	The user identifier as a 128 bit GUID.
username	string		The user's username
email	string		The user's email
firstname	string		The user's firstname
lastname	string		The user's lastname
timezone	string	Timezone offset name	The user's timezone preference
language	string	Language code	The user's language preference
custom.*	object		Additional custom data stored against the user
credentials	object		Container for authentication details
credentials.password	string		The password value when creating a user. The value is never returned in a response
credentials.provider	string		The security provider details for the user
credentials.provider.type	string		The security provider type
credentials.provider.name	string		The security provider name
status	object		Container for status information
status.suspended	boolean		A flag to indicate whether the user is active
status.locked	boolean		A flag to indicate whether the user is active
status.passwordResetRequired	boolean		A flag to indicate whether the user's password requires resetting
created	datetime		The date and time the user was first created
modified	datetime		The date and time the user was modified
lastLogin	datetime		The date and time the user last logged-in
passwordChanged	datetime		The date and time the user's password was last changed

Example

{
  "id": "e09e77b9-9dd9-4d46-b7dd-deb9702a5835",
  "username": "s.yearsley",
  "email": "[email protected]",
  "firstname": "Tyler",
  "lastname": "Durden",
  "timezone": "America/New_York",
  "language": "en-GB",
  "custom": {
    "title": "Mr",
    "department": "finance"
  },
  "credentials": {
    "provider": {
      "type": "contensis",
      "name": "contensis"
    }
  },
  "status": {
    "suspended": true,
    "locked": false,
    "passwordResetRequired": false
  },
  "created": "2020-06-24T16:39:18.000Z",
  "modified": "2020-06-24T16:39:18.000Z",
  "lastLogin": "2020-06-24T16:39:18.000Z",
  "passwordChanged": "2020-06-24T16:39:18.000Z"
}