Add Usergroup API
This API allows an admin user to add a user group in Applications Manager.
Syntax
For XML Response:
- https://[HOST]:[PORT]/AppManager/xml/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupName=[ Group Name ]&userName=[ User Name ]
- https://[HOST]:[PORT]/AppManager/xml/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupId=[ Monitor Group ID ]&userId=[ User ID ]
For JSON Response:
- https://[HOST]:[PORT]/AppManager/json/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupName=[ Group Name ]&userName=[ User Name ]
- https://[HOST]:[PORT]/AppManager/json/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupId=[ Monitor Group ID ]&userId=[ User ID ]
Supported HTTP methods: POST
Allowed roles: Administrator
Request Parameters
The parameters involved in executing this API request are:
Field |
Description |
apikey |
The key generated using the Generate API Key option in the Settings tab. |
userId |
The ID of the user who is to be associated with the user group. |
userName |
The name of the user to be added. |
usergroupName |
The name of the usergroup to be added. |
groupId |
The ID of the group is to be added. |
Sample Request
- https://apm-prod-server:8443/AppManager/xml/Usergroup/create?apikey=aaaaaabbbbbbccccccddddddeeeeee&usergroupName=sample&groupName=ApplicationsManager&userName=user
- https://apm-prod-server:8443/AppManager/xml/Usergroup/create?apikey=aaaaaabbbbbbccccccddddddeeeeee&usergroupName=sample&groupId=10011,10000019&userId=4,5