Add an Address Manager user.
API method:
POST /v1/addUser
Property options
| Option | Description |
|---|---|
| authenticator | The object ID of the external authenticator defined in Address Manager. |
| securityPrivilege | A security privilege type for non-administrative users with GUI,
API, or GUI and API access. Note: NO ACCESS
is the default value.
|
| historyPrivilege | A history privilege type for non-administrative users with GUI or
GUI and API access. Note: HIDE is the default
value.
|
| The user's email address (required). | |
| phoneNumber | The user's phone number (optional). |
| userType | ADMIN or
REGULAR Note: REGULAR
represents a non-administrative user and is the default
value.
|
| userAccessType | API, GUI, or
GUI_AND_API (required).
Note: 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. |
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 )