Parameter |
Label |
Description |
Type |
Filtering |
Max Length |
Options |
id |
Guardian system generated unique key |
int |
N/A |
|
|
|
firstName |
First Name |
User’s first name |
string |
GET |
40 |
|
lastName |
Last Name |
User’s last name |
string |
GET |
40 |
|
middleName |
Middle Name |
User’s middle name |
string |
GET |
25 |
|
title |
Title |
User’s title |
string |
GET |
80 |
|
emailAddress |
Email |
User’s email address |
string |
GET |
80 |
|
profileId |
Employee ID |
User’s company-issued identification |
string |
30 |
|
|
role |
Role |
Defines a group of permissions that outline the user’s capabilities within the system. |
int |
N/A |
|
|
workNumber |
Work Phone |
Work phone number |
string |
20 |
|
|
workExtension |
Ext |
Work phone extension number |
string |
10 |
|
|
homeNumber |
Home Phone |
Home phone number |
string |
20 |
|
|
cellNumber |
Cell Phone |
Cell phone number |
string |
20 |
|
|
login |
Login |
User’s system login name |
string |
GET |
80 |
|
password |
Password |
Optional custom password for the new user; if not sent, the password will be randomly generated. |
string |
80 |
|
|
oauthId |
OAuth ID |
Inserts or updates the user’s authentication credentials if OAuth 2.0 SSO is enabled for your organization. If this SSO method is not enabled, an error will be returned. |
string |
80 |
|
|
samlId |
SAML ID |
Inserts or updates the user’s authentication credentials if SAML SSO is enabled for your organization. If this SSO method is not enabled, an error will be returned. |
string |
80 |
|
|