User data fields

Utilize the following table to determine which parameters to include in your data feed file. Data fields are case sensitive. Ensure that the column headers match the listed parameters exactly. Since more than one file may be submitted, it is possible that each file contains different (more or less) data fields. As example, a file that includes all updates may only include the identifying column(s) and email address to update this data point. Only include columns you wish to populate.

If you are including additions and updates together, ensure that the rows are populated for each field expected to contain a value. Including columns that do not contain data for the individual rows, but for which data exists in Guardian will result in the clearing of that field.

Parameter Description Type Max Required for Creation
ID.profileId Identifying column parameter name; use when the existing user   record can be identified by the employee ID field string 30 Conditional1
ID.emailAddress Identifying column parameter name; use when the existing user   record can be identified by a combination of this parameter and ID.lastName and/or ID.firstName string 80 Conditional1
ID.firstName Identifying column parameter name; use when the existing user   record can be identified by a combination of this parameter and ID.lastName and/or ID.emailAddress string 40 Conditional1
ID.lastName Identifying column parameter name; use when the existing user   record can be identified by a combination of this parameter and ID.firstName and/or ID.emailAddress string 40 Conditional1
firstName User’s first name string 40 Yes
lastName User’s last name string 40 Yes
middleName User’s middle name string 25 No
role.name The name of the role to be assigned to the User string 80 Yes
title User’s title string 80 No
profileId User’s company-issued identification number string 30 Conditional2
emailAddress User’s email address string 80 Conditional2
workNumber Work phone number string 20 No
workExtension Work phone extension number string 10 No
homeNumber Home phone number string 20 No
cellNumber Cell phone number string 20 No
login User’s system login name string 80 No
password Optional password for the new user string 80 No
sendLoginEmail Indicates if email about login info should be sent to the user; if custom login or password information is not included, a randomly generated login and password will be auto-created by Guardian bool N/A No

1 Either emailAddress or profileId must be provided (identifies uniqueness of user) when creating a new user. When creating a new user be sure to send a value for the field that you will later use as an identifying column (i.e. profileId or emailAddress) otherwise future updates of the user record could fail.

2 You must send one or more of these identifying column parameters when you intend to update existing user records.