For mobile applications, new users may need to reuse the API Key provided to successfully authenticated users, so that they can use it for remaining operations. Authenticator API allows users to fetch details like the their API Keys, Roles, image and any other information associated to the user for successful authentication.
API for XML Response:
https://[HOST]:[PORT]/AppManager/xml/Authenticator?j_username=[USERNAME]&j_password=[PASSWORD]
API for JSON Response:
https://[HOST]:[PORT]/AppManager/json/Authenticator?j_username=[USERNAME]&j_password=[PASSWORD]
Supported HTTP methods: POST
Allowed roles: Administrator, Operator, User, Manager
| Field | Description |
|---|---|
| j_username | Username has to be posted to the above mentioned request with 'j_username' as parameter name. |
| j_password | Password has to be posted to the above mentioned request with 'j_password' as parameter name. |
| Field | Description |
|---|---|
| APIKey | This is the API Key. |
| Description | This is the description of the user account given at the time of creation of user account |
| EmailID | This is the e-mail id of the user |
| GroupName | This is the typ of account the user has. ex: operator, admin, manager etc. |
| UserImage | This is User image path |
| UserID | This is the ID of the user |
| UserName | This is the username of the user. |
XML Input:
https://apm-prod-server:8443/AppManager/xml/Authenticator?j_username=admin&j_password=appman
XML Response:
<AppManager-response uri="/AppManager/xml/Authenticator">
<result>
<response response-code="4000">
<UserDetails EmailID="NA" UserID="1" Description="NA" UserName="admin" APIKey="aaaaaabbbbbbccccccddddddeeeeee" UserImage="/images/icon_user.gif" GroupName="ADMIN"/>
</response>
</result>
</AppManager-response>
JSON Input:
https://apm-prod-server:8443/AppManager/json/Authenticator?j_username=admin&j_password=appman
JSON Response:
{"response-code":"4000","response":{"uri":"/AppManager/json/Authenticator","result":[{"EmailID":"NA","UserID":"1","Description":"NA","UserName":"admin","APIKey":"aaaaaabbbbbbccccccddddddeeeeee","UserImage":"/images/icon_user.gif","GroupName":"ADMIN"}]}}
