Read and Review Automation Anywhere Documentation

Automation Anywhere Version 11.3

Close Contents

Contents

Open Contents

Retrieve a specific user

  • Updated: 5/06/2020
    • 11.3.x
    • Explore
    • Enterprise
    • API docs

Retrieve a specific user

Use the Get Use Details API to retrieve a specific user in the Control Room.

Prerequisites

View Users permission
Users who have view users permissions can retrieve details of a specific user.
JSON Web Token (JWT)
All Control Room APIs require a JSON Web Token (JWT) to access the APIs. Generate an authentication token using the Authentication API. See Authentication API.
  • URL: http://<your_control_room_url>/v1/usermanagement/users/{ID}.

    Replace the content in the angle brackets with your Control Room URL.

  • Method: GET.
  • Use the Swagger definition files installed with your Control Room to test the APIs. View the available Swagger APIs at: http://<your_control_room_url>/swagger/.
  • You can also use a REST client to complete this task

Procedure

  1. Add an authentication token to the request header.
    Use the Authentication API to generate a JSON Web Token. See Authentication API.
  2. Select GET as the method.
  3. In the request header, add a specific user ID you want to retrieve.
    GET http://<your_control_room_url>/v1/usermanagement/users/35
  4. Send the request.
    • In Swagger, click Execute.
    • In a REST client, click SEND.
    Response body:
    {
      "id": 35,
      "email": "aa@aa.com",
      "username": "docbotusermd100",
      "domain": "ActiveDirectory (LDAP)",
      "firstName": "AAMHD4",
      "lastName": "AAMHD5",
      "version": 0,
      "principalId": 35,
      "deleted": false,
      "roles": [{
        "name": "DocBotRole03",
        "id": 18,
        "version": 0
      }],
      "sysAssignedRoles": [],
      "groupNames": [],
      "permissions": [{
        "id": 134,
        "action": "viewuserbasic",
        "resourceId": null,
        "resourceType": "usermanagement"
      }],
      "licenseFeatures": ["DEVELOPMENT"],
      "emailVerified": true,
      "passwordSet": false,
      "questionsSet": false,
      "enableAutoLogin": true,
      "disabled": false,
      "clientRegistered": false,
      "description": "Created a user for running bots",
      "createdBy": 4,
      "createdOn": "2019-12-16T23:00:58Z",
      "updatedBy": 4,
      "updatedOn": "2019-12-16T23:00:58Z",
      "publicKey": null,
      "appType": null,
      "routingName": null,
      "appUrl": null
    }
Note: You can also run REST requests from a command terminal. The following is a curl request example. This example is formatted for readability. Replace the text inside the angle brackets, <authentication_token>, with your authentication token.
curl -X GET "http://<your_control_room_url>/v1/usermanagement/users/11" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{35}"
Send Feedback