CreateUserDbObject
The object used to create a new user when DB authentication is used.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
id |
The user ID. If provided, the GUID will be used. Otherwise, the function will auto-create it. |
- |
string |
uuid |
userName |
The login username for the user |
Y |
string |
|
firstName |
User's first name |
- |
string |
|
lastName |
User's last name |
- |
string |
|
|
User's email address - needed for automation and messaging |
- |
string |
|
proxyAccount |
The user's proxy account needed for connecting to different data sources |
- |
string |
|
adminType |
Set the user's administration level using the admin type enumeration |
Y |
||
roleIds |
The user's roles using role ID's |
- |
array |
|
clientLicenseType |
The user's license type using the type enumeration |
Y |
||
statusID |
The user's status using the status type enumeration |
Y |
||
tenantId |
The user's tenancy if using multi-tenancy. If not, use the default tenancy of '90000000-0000-0000-0000-000000000009' |
- |
string |
|
privateProfileId |
The user's Profile Id |
- |
string |
|
password |
User's password. The user can manually change their password later if enabled from the admin |
Y |
string |
|
phone |
User's phone - needed for automation and messaging |
- |
string |
*Required elements are only used for API parameters