Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Refresh token

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

Refresh token

Generate a JSON Web Token using a valid existing token. This endpoint provides you with a new token without the need to collect and authenticate credentials every time a token expires. By default, a token is valid for 20 minutes.

Request

POST https://{{ControlRoomURL}}/v1/authentication/token
Header: X-Authorization <<authentication token>>
All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON Web Token. See Authentication API.
Request body:
{
    "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDgwNjEsImV4cCI6MTU3MzEwOTI2MSwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc3NTA4OTY5NzUxMDAsImNzcmZUb2tlbiI6ImJiNjgzMGJhMDY5MWYwYjZiM2M3MDE4NGY0OGM0MWY1In0.f3kPRspfm0sei9DGHd9NoyLK-iCO-vs--8b_pLG9XSUR0186uvXFopB75eVAaG-1l_AZhR78UE6Voi7_UggzHkLRrEpQ-szR7cmFDpLxZ28xLnFJYhaIuMNdw9dWDVquBWTQSpYGNJd56D-tFFHBodwVdNamqWHxaQebq1zMyUyQV6Q-gKdgubpT5gwuXnp-BwScjHOYM3Fpj_nt0nEbJC5uWpJNtLQBpVzhsRwwlRKNOHQVbo6X7zkvKBoij8ewa5FWQwX7T-760BeqfssR6mmMUo0zRaneUKAYAskz0B-X5PcyCkrVJju2XqItQ9XMGNP7h_MaUDotU_CJyguPZA"
}

Request Parameters

Parameter Type Required Description
token String Yes Enter the token you want to refresh.

If the token is not valid, you must generate a token using one of the authentication methods: Authenticate (username and password) or Authenticate (username and apiKey).

Response

200 OK
{
    "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbIkRFVkVMT1BNRU5UIl0sImFuYWx5dGljc0xpY2Vuc2VzUHVyY2hhc2VkIjp7IkFuYWx5dGljc0NsaWVudCI6ZmFsc2V9LCJ0ZW5hbnRVdWlkIjoiMjgyOTc4YzQtNjM4Ni1jMTNhLTkyYWMtNTAwOWUzY2ZkNmIzIiwiaHlicmlkVGVuYW50IjoiIiwibXVsdGlwbGVMb2dpbiI6ZmFsc2UsImlhdCI6MTY0OTQ1NDg3MSwiZXhwIjoxNjQ5NDU2MDcxLCJpc3MiOiJBdXRvbWF0aW9uQW55d2hlcmUiLCJuYW5vVGltZSI6NDAyNzk2NTMyNjQ5NTY5fQ.vMQMyhw3-FQSjPe_3n5YffALFWbrZlW7IMxqCUVFApMhJbNA8-4FZX34j1JTz0NWm0SPn8R-rQCCM4tr5K8xTMlX7Ba04UWgmDCDltUOvP_NOcPOxlaeWyeu1-JOj35mdtTrfkxgVJLCIShRtnf1ScYDFPevsN1-zDWTsg_amriYZOtUWbTLV7TcbTlnqBK6My3ZKTparWhxi68N9P5-b1Ngj22mUJjm4iQ_DFPjv4wsSdQJCkCqV25o47cxos5MpLU5_ZAzlSJhCkZm4WpqvqRB8MJDJ3ZWd1P3LBK3KSe8ZdpYlis1RWGBLjKX3LLR7by6Lrkj5YRpwSOSyVEucw",
    "user": {
        "id": 3,
        "username": "jdoe_user",
        "domain": null,
        "firstName": "John",
        "lastName": "Doe",
        "version": 268,
        "principalId": 3,
        "deleted": false,
        "roles": [
            {
                "name": "Device_admin",
                "id": 24,
                "version": 3
            }
        ],
        "sysAssignedRoles": [],
        "groupNames": [],
        "permissions": [
            {
                "id": 163,
                "action": "own",
                "resourceId": "1",
                "resourceType": "queue"
            },
            {
                "id": 141,
                "action": "cancelcheckout",
                "resourceId": null,
                "resourceType": "repositorymanager"
            },
            {
                "id": 165,
                "action": "own",
                "resourceId": "1",
                "resourceType": "pool"
            },
            {
                "id": 97,
                "action": "register",
                "resourceId": null,
                "resourceType": "devices"
            },
            {
                "id": 161,
                "action": "participate",
                "resourceId": "1",
                "resourceType": "queue"
            },
            {
                "id": 29,
                "action": "view",
                "resourceId": null,
                "resourceType": "repositorymanager"
            },
            {
                "id": 164,
                "action": "manage",
                "resourceId": "1",
                "resourceType": "pool"
            },
            {
                "id": 31,
                "action": "export",
                "resourceId": null,
                "resourceType": "repositorymanager"
            },
            {
                "id": 32,
                "action": "import",
                "resourceId": null,
                "resourceType": "repositorymanager"
            }
        ],
        "licenseFeatures": [
            "DEVELOPMENT"
        ],
        "emailVerified": true,
        "passwordSet": true,
        "questionsSet": true,
        "enableAutoLogin": true,
        "disabled": false,
        "clientRegistered": false,
        "description": "",
        "createdBy": 1,
        "createdOn": "2022-03-17T19:33:06Z",
        "updatedBy": 1,
        "updatedOn": "2022-04-08T21:54:29Z",
        "publicKey": null,
        "appType": null,
        "routingName": null,
        "appUrl": null,
        "email": "jdoe@aa.com",
        "lastLoginTime": "2022-04-08T21:54:15Z",
        "deviceCredentialAttested": false,
        "multipleLoginAllowed": true
    },
    "tenantUuid": "282978c4-6386-c13a-92ac-5009e3cfd6b3",
    "mfaAuthResponse": 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.
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