ManageEngine® Applications Manager


Chapter 10.8 ListUserDetails API

<< Prev

Home

Next >>

 

ListUserDetails API

 

This API is used to get user details such as the role of the user, username and API key of the user.

Sample Request


http://[Host]:[Port]/AppManager/xml/ListUserDetails?apikey=[APIKEY]

 

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 'Admin' tab.

Example


http://app-windows:59090/AppManager/xml/ListUserDetails?apikey=93c6eb60184e41f10fba2f365060b8e3


Example Output
:

<AppManager-response uri="/AppManager/xml/ListUserDetails">
   <result>
      <response method="ListUserDetails">
         <Users>
            <User UserName="admin" Role="ADMIN" APIKey="93c6eb60184e41f10fba2f365060b8e3"/>
            <User UserName="admin" Role="USERS" APIKey="93c6eb60184e41f10fba2f365060b8e3"/>
            <User UserName="op" Role="OPERATOR" APIKey="a66d4543e9883be697df70f34e6a228d"/>
            <User UserName="user" Role="USERS" APIKey="8d3a9ed09d4e8d77adf7cb428fbb8533"/>
            <User UserName="man" Role="MANAGER" APIKey="5b45a2e137cb3059011613499e235676"/>
         </Users>
      </response>
   </result>
</AppManager-response>

If the API is not executed correctly, the request will fail and errors will be shown as given below:

 

<AppManager-response uri="/AppManager/xml/ListUserDetails">
   <result>
      <response response-code="4004">
         <message>The specified apikey [ "+apiKey+" ] in the request is invalid. Kindly login to Application Manager and check for the key in generate key in Admin tab.</message>
      </response>    
    </result>
</Apm-response>

Refer this page for a list of common error conditions.

Top

<< Prev

Home

Next >>

AddMonitor API - Cloud Apps

PollNow API