User Object Reference

Example User Object

Below is an example of a JSON representation of a user in the system. You will find users represented this way in server responses, and you can use this same format when creating or modifying existing users.

{
  "id": "ff80808141e1f27e0141e2c914ba0001",
  "firstName": "Stuart",
  "lastName": "Jackson",
  "username": "sjackson",
  "email": "sjackson@exampleorg.com",
  "password": "",
  "locale": "en",
  "tags": [ "earlyaccess", "summercampaign" ],
  "createdDate": "2013-10-23T00:48:50Z",
  "lastLoginDate": "2013-10-23T01:03:51Z"
}

Property Details

Property	JSON Data Type	Description
id	string	The user’s unique identifier value. A user’s URL in the API is composed of /dc/api/v5/users/ followed by this identifier.
firstName	string	The first name of the user.
lastName	string	The last name of the user.
username	string	The username of the user. Note that if your organization does not have the username feature enabled, this field is not relevant and may be omitted.
email	string	The email address of the user.
password	string	The user’s password. This field will never be present in responses sent by the server, but you can include this property when creating a user or modifying an existing user’s password. The value must be at least 6 characters in length and must contain at least one letter and one number.
locale	string	The ISO 639-1 locale code, associating the user with a particular locale. This is used to determine the language that should be used for text in the user interface and various other text formatting operations.
tags	array of strings	The tags associated with the user. These are only visible to administrators, never to end users. A single tag value may not contain either commas or spaces. If you include a space or a comma in a single value, it will be split into multiple tags.
createdDate	string	A date string representing the timestamp when the user was first created. For further information on the expected format, see the Date/Time Format documentation. This property is read-only.
lastLoginDate	string	A date string representing the timestamp when the user last logged into the system. For further information on the expected format, see the Date/Time Format documentation. This property is read-only.