Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Authenticate with username and apiKey API

  • Updated: 1/06/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Authenticate with username and apiKey API

Generate a JSON Web Token with your Control Room username and an apikey. This endpoint enables users to generate the token without the need for the user's password, such as for organizations that use single sign-on (SSO). By default, a token is valid for 20 minutes.

Prerequisites

Note: You can 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.

To generate the token, you require the following:

  • A custom role with the Generate API-Key permission
  • Valid username and API-key to the Control Room. The API-Key is a 40-character string generated in the Control Room.

    Create and assign API key generation role

Procedure

  1. Use the POST method and endpoint URL: <your_control_room_url>/v1/authentication.
    Request body:
    {
    "username": "jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
    Request body with domain: Depending on how your Control Room is configured, a domain might be required with the username.
    {
    "username": "your-domain\\jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
  2. Send the request.
    Response body: A successful response returns the token as a 703-character string.
    {
      "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": "",
        "lastName": "",
        "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": "2019-10-10T13:39:56-05:00",
        "updatedBy": 1,
        "updatedOn": "2019-10-13T02:09:38-05:00",
        "publicKey": null,
        "appType": null,
        "routingName": null,
        "appUrl": null
      }
    }

Next steps

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