ManageEngine® Applications Manager ListUserDetails API | ||
This API allows an admin user to fetch the details of all the users. Users other than admin can only access their own details.
For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/?apikey=[ API Key ]
For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/?apikey=[ API Key ]
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.
For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/[userId]?apikey=[ API Key ]
(OR) http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/[username]?apikey=[ API Key ]
For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/[userId]?apikey=[ API Key ]
(OR) http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/[username]?apikey=[ API Key ]
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 'Admin' tab. |
http://app-windows:59090/AppManager/xml/Users?apikey=93c6eb60184e41f10fba2f365060b8e3
http://app-windows:59090/AppManager/xml/Users/1?apikey=93c6eb60184e41f10fba2f365060b8e3
http://app-windows:59090/AppManager/xml/Users/admin?apikey=93c6eb60184e41f10fba2f365060b8e3
Example Output:
<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: http://[Host]:[Port]/AppManager/xml/ListUserDetails?apikey=[APIKEY] ) will continue to work till the next release. |
Get All User Roles |
UpdateUser API |