automation-anywhere LockerConsumers API

Manage roles with consumer access to locker credentials

Business capability
Identity & Access Management BC-620.20

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /lockers/{id}/consumers List roles with consumer access to a locker · List locker consumers #
Ask an LLM
“Which roles can let bots use the credentials in a given Locker?”
“Who are the consumers of this Locker?”
Tell an agent
List the consumer roles of locker {id}.
Show which roles consume credentials from locker {id}.
POST /lockers/{id}/consumers Grant a role consumer access to a locker · Add a locker consumer #
Ask an LLM
“How do I let bots under a role retrieve credentials from a Locker?”
“Can I add a role as a consumer of a Locker?”
Tell an agent
Add role {roleId} as a consumer of locker {id}.
Give bots in role {roleId} access to the credentials in locker {id}.
DELETE /lockers/{id}/consumers/{roleId} Revoke a role's consumer access to a locker · Remove a locker consumer #
Ask an LLM
“Can I stop a role's bots from pulling credentials out of a Locker?”
“What happens to bots when their role is removed as a Locker consumer?”
Tell an agent destructive · confirm first
Remove role {roleId} as a consumer of locker {id}.
Revoke consumer access for role {roleId} on locker {id}.

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/automation-anywhere:automation-anywhere-lockerconsumers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

automation-anywhere-lockerconsumers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Automation Anywhere Credential Vault Locker Consumers API
  description: The Automation Anywhere Credential Vault API provides programmatic access to the Control Room's centralized secrets management system.
  version: '2019'
  contact:
    name: Automation Anywhere Support
    url: https://support.automationanywhere.com
  termsOfService: https://www.automationanywhere.com/terms-of-service
servers:
- url: https://{controlRoomUrl}/v2/credentialvault
  description: Automation Anywhere Control Room Credential Vault API v2
  variables:
    controlRoomUrl:
      default: your-control-room.automationanywhere.com
      description: Your Control Room hostname
security:
- bearerAuth: []
- xAuthorization: []
tags:
- name: LockerConsumers
  description: Manage roles with consumer access to locker credentials
paths:
  /lockers/{id}/consumers:
    get:
      operationId: listLockerConsumers
      summary: List locker consumers
      description: Returns all roles that have consumer access to the credentials in the specified Locker. Consumer roles are used by bots to retrieve credential values during automation execution.
      tags:
      - LockerConsumers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      responses:
        '200':
          description: List of consumer roles for the locker
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LockerConsumerList'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Locker not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: addLockerConsumer
      summary: Add a locker consumer
      description: Grants a role consumer access to the credentials in the specified Locker. Bots assigned to this role can then retrieve credential values from this Locker during execution.
      tags:
      - LockerConsumers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LockerConsumerPost'
      responses:
        '200':
          description: Consumer role added to locker successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LockerConsumer'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Locker not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /lockers/{id}/consumers/{roleId}:
    delete:
      operationId: removeLockerConsumer
      summary: Remove a locker consumer
      description: Revokes a role's consumer access to the credentials in the specified Locker. Bots assigned to this role will no longer be able to retrieve credential values through this Locker.
      tags:
      - LockerConsumers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      - name: roleId
        in: path
        required: true
        description: Numeric ID of the consumer role to remove
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Consumer role removed from locker successfully
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Locker or consumer role not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      description: Standard error response
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error description
    LockerConsumerPost:
      type: object
      description: Payload to add a consumer role to a locker
      required:
      - roleId
      properties:
        roleId:
          type: integer
          format: int64
          description: ID of the role to grant consumer access
    LockerConsumerList:
      type: object
      description: List of consumer roles for a locker
      properties:
        list:
          type: array
          description: Array of consumer role records
          items:
            $ref: '#/components/schemas/LockerConsumer'
    LockerConsumer:
      type: object
      description: A role with consumer access to a locker's credentials
      properties:
        roleId:
          type: integer
          format: int64
          description: Unique identifier of the consumer role
        roleName:
          type: string
          description: Name of the consumer role
  parameters:
    LockerIdParam:
      name: id
      in: path
      required: true
      description: Unique numeric identifier of the locker
      schema:
        type: integer
        format: int64
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from the Authentication API
    xAuthorization:
      type: apiKey
      in: header
      name: X-Authorization
      description: JWT token obtained from the Authentication API
externalDocs:
  description: Automation Anywhere Credential Vault API Documentation
  url: https://docs.automationanywhere.com/bundle/enterprise-v2019/page/cv-api-supported.html