{
  "opencollection": "1.0.0",
  "info": {
    "name": "Automation Anywhere API Task Execution AccessDetails Credentials 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}/orchestrator/v1/hotbot/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}/orchestrator/v1/hotbot/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}/orchestrator/v1/hotbot/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}/orchestrator/v1/hotbot/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}/orchestrator/v1/hotbot/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}/orchestrator/v1/hotbot/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."
        }
      ]
    }
  ],
  "bundled": true
}