ListUserDetails API
Users Details
This API allows an admin user to fetch the details of all the users. Users other than admin can only access their own details.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/Users?apikey=[ API Key ]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/Users?apikey=[ API Key ]
User ID Details
This API allows an admin user to fetch the details of a particular user, by providing either the user ID or user name. Other users can only access their own details.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/Users/[userId]?apikey=[ API Key ]
[ OR ]
https://[HOST]:[PORT]/AppManager/xml/Users/[username]?apikey=[ API Key ]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/Users/[userId]?apikey=[ API Key ]
[ OR ]
https://[HOST]:[PORT]/AppManager/json/Users/[username]?apikey=[ API Key ]
Supported HTTP methods: GET
Allowed roles: Administrator
Request Parameters
The parameters involved in executing this API request are:
| Field | Description |
|---|
| userId | Id of the user whose detail is to be fetched. |
| userName | The user name of the user whose detail is to be fetched. |
| apikey | The key generated using the Generate API Key option in the Settings tab. |
Sample Requests
- https://apm-prod-server:8443/AppManager/xml/Users?apikey=aaaaaabbbbbbccccccddddddeeeeee
- https://apm-prod-server:8443/AppManager/xml/Users/1?apikey=aaaaaabbbbbbccccccddddddeeeeee
- https://apm-prod-server:8443/AppManager/xml/Users/admin?apikey=aaaaaabbbbbbccccccddddddeeeeee
Sample Response
<AppManager-response uri="/AppManager/xml/users/6">
<result>
<response response-code="4000">
<User email="manager" userId="6" description="manager" userName="manager" role="MANAGER">
<AssociatedGroups groupId="10000035" groupName="Applications Manager"/>
<AssociatedGroups groupId="10000037" groupName="mg1"/>
<AssociatedGroups groupId="10000038" groupName="mg2"/>
</User>
</response>
</result>
</AppManager-response>
Note:
Deprecated API: The above API will work for users using Applications Manager 11030 and above. For users with lower versions, the ListUserDetails API (Sample: https://[HOST]:[PORT]/AppManager/xml/ListUserDetails?apikey=[APIKEY]) will continue to work till the next release.
