Skip to main content

User attributes

Developers enable custom attribute fields that Company Administrators will be prompted for during User Assignment operations. See Assign applications to users. They select these fields in the User information to sync pane on the Edit integration page.

User AttributeData point on User information to syncDescription
companyTitleJob TitleA job title provided by a user in a free-form text field, such as "Vice President"or "Engineer".
companyDepartmentDepartmentA company department provided by a user in a free-form text field, such as "HR" or "Sales".
zipCodeZip CodeA ZIP or postal code provided by a user in a free-form text field, such as "90210" or "M1 1AA".
billingRateBilling RateA billing rate provided by a user in a free-form text field , such as "$100 an hour" or "500€ daily".
timeZoneTimezoneA user-provided time zone selected from valid tz zone values, such as "America/Pacific" or "Europe/Copenhagen".
appAdminApplication Administrator StatusA boolean value indicating whether the user should be an application administrator, such as "true" or "false".
accessRightsView / Edit RightsA boolean value indicating whether the user should have access rights, such as "true" or "false".
usernameUsernameA user name provided by the user in a free-form text field, such as "exampleuser@testco.com" or "ExampleUser".
passwordPasswordA password provided by the user in a free-form password text field, such as "secretPassword" or "abc123".
idNumberIdentification NumberAn identification number provided by the user in a free-form text field, such as "9870123" or "12436769090".
accountIdentifierAccount IdentifierAn identification number provided by a user in a free-form text field, such as “1234“ or “example.com“.

These values will appear as part of the JSON or XML user payload as a list of key/value pairs, an example of which is shown below.

  • JSON
  "user": {  
...
"attributes": {
"entry": [
{
"key": "timezone",
"value": "America/Pacific"
},
{
"key": "zipCode",
"value": "90210"
},
{
"key": "zipCode",
"value": "90210"
}
]
}
...
}
  • XML
<?xml version="1.0" encoding="UTF-8" ?>  
<user>
...
<attributes>
<entry>
<key>timezone</key>
<value>America/Pacific</value>
</entry>
<entry>
<key>zipCode</key>
<value>90210</value>
</entry>
<entry>
<key>zipCode</key>
<value>90210</value>
</entry>
</attributes>
...
</user>

Was this page helpful?