Skip to main content
Browse Documentation
HTTP - Management

User

Created by j.moore, last modified by zengenti on 25 Jun 2021

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 first name
lastNamestringThe user's last name
timezonestringtimezone offset nameThe 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
expirydatetimedatetimeThe expiry date for the user
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",
    "expiry": "2050-12-31T23:59:59.999Z",
    "passwordChanged": "2020-06-24T16:39:18.000Z"
}
Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.