Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Configure a locker using API

  • Updated: 1/31/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

Configure a locker using API

Use a combination of endpoints to create a locker and assign locker access permissions to users.

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.
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • You must be assigned the AAE_Admin, AAE_Locker Admin role or have a custom role that includes the Manage my lockers permission.

You will provide the role ID to assign consumer access to users Search for roles API.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL:<your_control_room_url>/v2/credentialvault/lockers to create the locker.
    Request body:
    {
      "name": "HumanResourcesCredentials",
      "description": "Login credentials for the HR dept"
    }
  3. Send the request.
    Response body: In a successful request, this endpoint returns the id, which is a unique numeric identifier for the locker. Use the locker ID in subsequent API requests, such as to add consumers or credentials to the locker.
    {
        "id": "1551",
        "name": "HumanResourcesCredentials",
        "description": "Login credentials for the HR dept",
        "createdBy": "1508",
        "createdOn": "2020-12-28T22:24:40.462253Z",
        "updatedBy": "1508",
        "updatedOn": "2020-12-28T22:24:40.462259Z",
        "version": "0"
    }
    The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Assign locker access permissions to users. Locker permissions

  1. Optional: Assign another locker owner. Use the PUT method and endpoint URL:<your_control_room_url>/v2/credentialvault/lockers/{lockerId}/members/{userId}.
    Note: The locker creator is automatically assigned the locker owner permission.
    Request body:
    {
      "permissions": [
        "own"
      ]
    }
  2. Send the request.
    Response body: This endpoint does not return data.
  3. Optional: Assign a locker manager. Use the PUT method and endpoint URL:<your_control_room_url>/v2/credentialvault/lockers/{lockerId}/members/{userId}.
    Request body:
    {
      "permissions": [
        "manage"
      ]
    }
  4. Send the request.
    Response body: This endpoint does not return data.
  5. Optional: Assign a locker participant. Use the PUT method and endpoint URL:<your_control_room_url>/v2/credentialvault/lockers/{lockerId}/members/{userId}.
    Request body:
    {
      "permissions": [
        "participate"
      ]
    }
  6. Send the request.
    Response body: This endpoint does not return data.
  7. Assign locker consumers. Use the POST method and endpoint URL:: <your_control_room_url>/v2/credentialvault/lockers/{lockerId}/consumers
    Request body: Provide the role ID. All users who are assigned that custom role can build and run bots using the credentials in this locker, as well as enter values into credentials that accept user-provided attribute values.
    {
        "id":"516"
    }
  8. Send the request.
    Response body: This endpoint does not return data.

Next steps

If you are following the steps to configure your Credential Vault, do this next: Assign credential to locker API.
Send Feedback