Create User API


This API will allow admin to create a new user in Applications Manager.

Syntax

For XML Response:

https://[HOST]:[PORT]/AppManager/xml/Users/create?apikey=[API Key]&userName=[USERNAME]&role=[ROLE]&password=[PASSWORD]&email=[EMAIL]

For JSON Response:

https://[HOST]:[PORT]/AppManager/json/Users/create?apikey=[API Key]&userName=[USERNAME]&role=[ROLE]&password=[PASSWORD]&email=[EMAIL]

Supported HTTP methods: POST

Allowed roles: Administrator

Request Parameters

The parameters involved in the API request are described below:

Field Description
userName The user name of the user.
role User group of the new user. Possible values are OPERATOR, MANAGER, ADMIN, USER, DELEGATEDADMIN.
password Password of the new user.
email Email ID of the user.
description (optional) Description of the user.
groupId (optional) Group ID of the monitor groups to which the user needs to be associated. The group IDs should be comma separated.
groupName (optional) Name of a monitor group to which the user needs to be associated. If groupId is provided, this parameter will be ignored.
usergroupId (optional) ID of the user group to which the user needs to be associated. The user group IDs should be comma-separated.
usergroupName (optional) Name of the user group to which the user needs to be associated. If usergroupId is provided, this parameter will be ignored.
domainid (optional) ID of the domain to which the user needs to be associated. The domain IDs should be comma-separated.
domainname (optional) Name of a domain to which the user needs to be associated. If domainid is provided, this parameter will be ignored.

Sample Request

https://apm-prod-server:8443/AppManager/xml/Users/create?apikey=aaaaaabbbbbbccccccddddddeeeeee&userName=admin&role=MANAGER&password=appman&email=example@example.com

Sample Response

<AppManager-response uri="/AppManager/xml/users/create">
<result> <response response-code="4000">
<User email="example@example.com" userId="6" description="manager" userName="admin" role="MANAGER">
<AssociatedGroups groupId="10000035" groupName="Applications Manager"/>
<AssociatedGroups groupId="10000037" groupName="mg1"/>
<AssociatedGroups groupId="10000038" groupName="mg2"/>
</User>
</response>
</result>
</AppManager-response>