Adds Address Manager users.
Output / Response
Returns the object ID for the new Address Manager user.
Tip: To add users to a user
group, use the linkEntities() method, specifying the user ID
and the group ID. It does not matter which entity is used as the user ID or the
group ID. Either of the following Java examples will add a user to a user
group:
void linkEntities ( long user_id, long group_id, String properties ) or void linkEntities ( long group_id, long user_id, String properties )
API Call:
long addUser( String username, String
password, String properties
)
| Parameter | Description |
|---|---|
| username | The name of the user. |
| password | The Address Manager password for the user. The password must be set even if the authenticator property option is defined. |
| properties | A string containing user-defined fields and options listed in List of options. Multiple property values can be separated
by a | (pipe) character. For example: my $properties =
“email=$email|phoneNumber=$tel|authenticator=1368969|userAccessType=$accessType” Note: You
must add a | (pipe) character at the end in the properties
string.
|
List of options
| authenticator | The object ID of the external authenticator defined in Address Manager. |
| securityPrivilege | A security privilege type for Non-Administrator users with GUI, API, or GUI and API access. NO ACCESS is the default value. |
| historyPrivilege | A history privilege type for Non-Administrator users with GUI, or GUI and API access. HIDE is the default value. |
| The email address for the user. This is required. | |
| phoneNumber | The phone number for the user. |
| UserType | ADMIN or REGULAR (non-administrator—REGULAR is the default value). |
| UserAccessType | API, GUI, or GUI and API. This is required. This string must be one of the constants listed in User Access Type. |
User types and access types
| UserType | UserAccessType | Privileges |
|---|---|---|
| ADMIN | n/a | History and Security privileges are set automatically. |
| REGULAR | GUI | History and Security privileges are set to a user-specific value. |
| REGULAR | API | Security privilege is set to a user-specific value. |
| REGULAR | GUI and API | History and Security privileges are set to a user-specific value. |