Skip to main content
Browse Documentation
HTTP - Management

User

Created by j.moore, last modified by s.yearsley on 24 Sep 2020

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

NameData typeData formatDescription
idstringGUIDThe user identifier as a 128 bit GUID.
usernamestringThe user's username
emailstringThe user's email
firstnamestringThe user's firstname
lastnamestringThe user's lastname
timezonestringThe user's timezone preference
languagestringlanguage codeThe user's language preference
custom.*objectAdditional custom data stored against the user
credentialsobjectContainer for authentication details
credentials.passwordstringThe password value when creating a user. The value is never returned in a response
statusobjectContainer for status information
status.activebooleanA flag to indicate whether the user is active
status.lockedbooleanA flag to indicate whether the user's access has been locked
status.passwordResetRequiredbooleanA flag to indicate whether the user's password requires resetting
createddatetimeThe date and time the user was first created
modifieddatetimeThe date and time the user was modified
lastLogindatetimeThe date and time the user last logged-in
passwordChangeddatetimeThe date and time the user's password was last changed

Example

An example user resource

{
    "id": "e09e77b9-9dd9-4d46-b7dd-deb9702a5835",
    "username": "s.yearsley",
    "email": "s.yearsley@zengenti.com",
    "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"
}