List credentials using API

Read and Review Automation Anywhere Documentation

Automation 360

Download PDF

List credentials using API

Return a list of the credentials for which you are the owner or have access through a locker. If you have the AAE_Locker Admin role, this endpoint returns all the credentials in the Control Room.

Prerequisites

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.

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.
You must have access to the credential, either as the credential owner or through a locker.

Procedure

Add the authentication token to the request header.
Use the POST method and endpoint URL: <your_control_room_url>/credentialvault/credentials.

Note: Append the ?consumed=true parameter to the URL to return a list of credentials that have user-input values and are being used in bots.
Request body: Send an empty request to return all the credentials, sorted in alphabetical order.
```
{
    sort: [
        {
            field: "name",
            direction: "asc"
        }
    ]
 }
```

Send the request.

Response body: The response returns the ID of each attribute and the userProvided parameter, which informs whether the value is set by each user (true) or is standard for all users (false).

{
    "page": {
        "offset": 0,
        "total": 1,
        "totalFilter": 1
    },
    "list": [
    {
        "id": "1630",
        "name": "Email",
        "description": "",
        "ownerId": "1508",
        "attributes": [
            {
            "id": "3335",
            "name": "hostname",
            "description": "",
            "userProvided": false,
            "masked": false,
            "createdBy": "1508",
            "createdOn": "2020-12-28T22:04:41.366448Z",
            "updatedBy": "1508",
            "updatedOn": "2020-12-28T22:04:41.366450Z",
            "version": "0",
            "passwordFlag": false
        },
        {
            "id": "3336",
            "name": "username",
            "description": "",
            "userProvided": true,
            "masked": false,
            "createdBy": "1508",
            "createdOn": "2020-12-28T22:04:41.366450Z",
            "updatedBy": "1508",
            "updatedOn": "2020-12-28T22:04:41.366450Z",
            "version": "0",
            "passwordFlag": false
        },
        {
            "id": "3337",
            "name": "password",
            "description": "",
            "userProvided": true,
            "masked": true,
            "createdBy": "1508",
            "createdOn": "2020-12-28T22:04:41.366450Z",
            "updatedBy": "1508",
            "updatedOn": "2020-12-28T22:04:41.366450Z",
            "version": "0",
            "passwordFlag": false
        }
     ],   
     "createdBy": "1508",
     "createdOn": "2020-12-28T22:04:41.366460Z",
     "updatedBy": "1508",
     "updatedOn": "2020-12-28T22:06:35.366464Z",
     "version": "2",
     "completed": true
        }
    ]
}

The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Next steps

Now that you have the IDs of attributes that accept a user-input value, next Assign value to attribute using API.

Send Feedback