{
  "opencollection": "1.0.0",
  "info": {
    "name": "Automation Anywhere Credential Vault API",
    "version": "2019"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Credentials",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a credential",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new credential in the Credential Vault. A credential consists of a name, optional description, and one or more typed attributes (such as username and password fields). Once created, credentials must be added to a Locker to be accessible by bots."
        },
        {
          "info": {
            "name": "Search credentials",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/list",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Searches for credentials where the authenticated user is the owner or has access through a Locker. Supports filtering, sorting, and pagination. Only credential metadata is returned; attribute values are not included in list responses."
        },
        {
          "info": {
            "name": "Get a credential by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              },
              {
                "name": "consumed",
                "value": "",
                "type": "query",
                "description": "Whether to return attribute values in bot-consumption format"
              }
            ]
          },
          "docs": "Retrieves a specific credential by its numeric ID, including its attributes and current values if the caller has access. The consumed query parameter controls whether to return attribute values intended for bot consumption."
        },
        {
          "info": {
            "name": "Update a credential",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing credential's name, description, or attributes. The caller must be the credential owner or have admin permissions. All attributes must be included in the request; omitted attributes will be removed."
        },
        {
          "info": {
            "name": "Delete a credential",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              }
            ]
          },
          "docs": "Permanently deletes a credential and all its associated attribute values from the Credential Vault. The credential must first be removed from any Lockers before it can be deleted."
        },
        {
          "info": {
            "name": "Update credential ownership",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id/owner/:credentialOwnerId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              },
              {
                "name": "credentialOwnerId",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user who will become the new credential owner"
              }
            ]
          },
          "docs": "Transfers ownership of a credential to another user. The new owner gains full administrative control over the credential including the ability to update, delete, and manage locker assignments."
        }
      ]
    },
    {
      "info": {
        "name": "AttributeValues",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List credential attribute values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id/attributevalues",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              },
              {
                "name": "credentialAttributeId",
                "value": "",
                "type": "query",
                "description": "Filter attribute values by this credential attribute ID"
              },
              {
                "name": "userId",
                "value": "",
                "type": "query",
                "description": "Filter attribute values scoped to this user ID"
              },
              {
                "name": "encryptionKey",
                "value": "",
                "type": "query",
                "description": "Encryption key identifier for decrypting attribute values"
              }
            ]
          },
          "docs": "Retrieves all attribute values for a specific credential. Returns the current values of each attribute defined on the credential. The credentialAttributeId, userId, and encryptionKey query parameters can be used to filter the returned attribute values."
        },
        {
          "info": {
            "name": "Create credential attribute values",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id/attributevalues",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets or creates new attribute values for a specific credential. Attribute values are the actual secret data (e.g., passwords) stored against credential attribute definitions. Values are encrypted at rest using the Credential Vault key pair."
        },
        {
          "info": {
            "name": "Update a credential attribute value",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id/attributevalues/:attributeValueId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              },
              {
                "name": "attributeValueId",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential attribute value"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the value of a specific attribute on a credential. Used to rotate passwords, API keys, or other secrets without changing the credential's structure. The new value is encrypted and stored securely."
        },
        {
          "info": {
            "name": "Delete a credential attribute value",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{controlRoomUrl}/v2/credentialvault/credentials/:id/attributevalues/:attributeValueId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential"
              },
              {
                "name": "attributeValueId",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the credential attribute value"
              }
            ]
          },
          "docs": "Removes a specific attribute value from a credential. After deletion, the attribute definition remains but the stored value is permanently removed from the Credential Vault."
        }
      ]
    },
    {
      "info": {
        "name": "Lockers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a locker",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Locker in the Credential Vault. A Locker is a permission-controlled container that groups credentials and controls which roles (consumers) can use the credentials within it during bot execution. Lockers are the primary access control mechanism for the Credential Vault."
        },
        {
          "info": {
            "name": "Search lockers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/list",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Searches for Lockers that the authenticated user has access to. Returns paginated results with locker metadata. Supports filtering by name and other attributes."
        },
        {
          "info": {
            "name": "Get a locker by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ]
          },
          "docs": "Retrieves a specific Locker by its numeric ID, including its name, description, and configuration. Does not include the list of contained credentials; use the locker credentials endpoint for that."
        },
        {
          "info": {
            "name": "Update a locker",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing Locker's name and description. The caller must have Locker owner permissions to update its details."
        },
        {
          "info": {
            "name": "Delete a locker",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ]
          },
          "docs": "Permanently deletes a Locker. All credential associations within the Locker are removed. The credentials themselves are not deleted; they remain in the Credential Vault but lose Locker-based access."
        },
        {
          "info": {
            "name": "Get locker credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/credentials",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ]
          },
          "docs": "Retrieves the list of credentials contained within a specific Locker. Returns credential metadata and the attributes available for bot consumption via the Locker's consumer roles."
        },
        {
          "info": {
            "name": "Update a credential in a locker",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/credentials/:credentialId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the association or configuration of a credential within a Locker. Used to modify which credential attributes are exposed to consumer roles through this Locker."
        },
        {
          "info": {
            "name": "Remove a credential from a locker",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/credentials/:credentialId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ]
          },
          "docs": "Removes a credential from a Locker, revoking consumer role access to that credential through this Locker. The credential itself remains in the Credential Vault."
        }
      ]
    },
    {
      "info": {
        "name": "LockerConsumers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List locker consumers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/consumers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Add a locker consumer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/consumers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Remove a locker consumer",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/consumers/:roleId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the consumer role to remove"
              }
            ]
          },
          "docs": "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."
        }
      ]
    },
    {
      "info": {
        "name": "LockerMembers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get locker members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/members",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              }
            ]
          },
          "docs": "Returns all users who are members of the specified Locker. Members have management access to the Locker and can add or remove credentials and manage consumer role assignments."
        },
        {
          "info": {
            "name": "Update locker member permissions",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/members/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a user as a Locker member or updates their membership permissions. Locker members can manage the Locker's contents and access control configuration."
        },
        {
          "info": {
            "name": "Remove a locker member",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{controlRoomUrl}/v2/credentialvault/lockers/:id/members/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the locker"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "Unique numeric identifier of the user"
              }
            ]
          },
          "docs": "Removes a user from Locker membership, revoking their ability to manage the Locker's credentials and access control settings."
        }
      ]
    }
  ],
  "bundled": true
}