Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Authenticate (username and password)

  • Updated: 2022/03/04
    • Automation 360 v.x
    • Manage
    • RPA Workspace

Authenticate (username and password)

Use this API to authenticate access to your Control Room with a valid username and password. A successfully completed response generates a JSON Web Token. By default, a token is valid for 20 minutes.

Request

POST http://{{ControlRoolURL}}/v1/authentication
Request body:
{
   "username":"jdoe",
   "password":"mypassword@123"
}
Request body to generate Multi-login token:
{
   "username":"jdoe",
   "password":"mypassword@123",
   "multipleLogin":true
}

Request Parameters

Parameter Type Description
username String Enter your user name.
password String Enter your password.
multipleLogin Boolean Allow or disallow multiple login. For more information on multi-login, see Multi-login user.
  • true - Allows multiple login
  • false - Disallows multiple login
Note: If this value is set to true, you will be allowed multiple API sessions.

Response

{
   "token":"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
   "user":{
      "id":9,
      "email":"a@a.com",
      "username":"jdoe",
      "domain":null,
      "firstName":"j",
      "lastName":"doe",
      "version":9,
      "principalId":9,
      "deleted":false,
      "roles":[
         {
            "name":"API_Key_Generation",
            "id":23,
            "version":0
         },
         {
            "name":"AAE_Basic",
            "id":2,
            "version":0
         },
         {
            "name":"Docrole1",
            "id":18,
            "version":0
         }
      ],
      "sysAssignedRoles":[
         
      ],
      "groupNames":[
         
      ],
      "permissions":[
         ". . ."
      ],
      "licenseFeatures":[
         "RUNTIME"
      ],
      "emailVerified":true,
      "passwordSet":true,
      "questionsSet":true,
      "enableAutoLogin":false,
      "disabled":false,
      "clientRegistered":false,
      "description":"",
      "createdBy":1,
      "createdOn":"2022-03-10T13:39:56-05:00",
      "updatedBy":1,
      "updatedOn":"2022-03-13T02:09:38-05:00",
      "publicKey":null,
      "appType":null,
      "routingName":null,
      "appUrl":null
   }
}

Response Parameters

Parameter Type Description
token String Generated access token that acts as a session ID that your application will use for making requests. This token is equivalent to the user credentials and must be protected.
Note: If multipleLogin is set to true, you will be able to use this token for multiple API sessions.
user Object The user object returned with all the details of the user.
  • id - Id of the user.
  • email - Email id of the user.
  • username - User name of the user.
  • domain - Domain logged in to.
  • firstname - First name of the user.
  • lastname - Last name of the user.
  • roles - Roles assigned to the user.
  • sysAssignedRoles - System assigned roles.
  • permissions - Permissions assigned to the user.
  • licenseFeatures - License assigned to the user.

Insert the token in the request header of subsequent API requests.

Note: For an Control Room that is deployed on Cloud and has SAML authentication enabled, generate the web token with your username and apikey.

Authenticate (username and apiKey)

Note: View the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.
Send Feedback