Credential Vault API

The Credential Vault securely stores sensitive information such as passwords, account numbers, and social security numbers in credentials and lockers for use in automation tasks. It facilitates role-based access for users of a Control Room and ensures that sensitive values are not stored in bots or on devices. The Credential Vault consists of two main features, credentials and lockers. The Automation Anywhere platform provides a centralized Credential Vault to securely store all credentials and provision them to bots on an on-demand basis.
Prerequisites

Control Room user with Manage my credentials and lockers feature permissions, you have the option to use the Credential Vault API to manage your attributes, credentials, and lockers in the Control Room.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Header file example: -H X-Authorization <authentication token> or Authorization:Bearer <bearer token>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

AttributeValues

Up

delete /credentials/{id}/attributevalues/{attributeValueId}

Delete credential attribute value of specific credential (credentialsIdAttributevaluesAttributeValueIdDelete)

Delete credential attribute value of specific credential

Path parameters

id (required)

Path Parameter — Id of the credential

attributeValueId (required)

Path Parameter — Id of the credential attribute value

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful delete

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /credentials/{id}/attributevalues/{attributeValueId}

Update credential attribute value of specific credential (credentialsIdAttributevaluesAttributeValueIdPut)

Update existing instances of attribute value for specific credential. User can change his user-provided attribute value or common value if he is allowed to do it.

Path parameters

id (required)

Path Parameter — Id of the credential

attributeValueId (required)

Path Parameter — Id of the credential attribute value

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body CredentialAttributeValuePut (required)

Body Parameter —

Query parameters

encryptionKey (optional)

Query Parameter — RSA public key used to encrypt the value. The key has to be encoded in Base64. Has to be retrieved from CV API ({{Control Room url}}/v2/credentialvault/keys/transport/public).

Return type

CredentialAttributeValue

Example data

Content-Type: application/json

{
  "password" : false,
  "updatedBy" : "38",
  "createdBy" : "38",
  "id" : "131",
  "credentialAttributeId" : "890",
  "updatedOn" : "2022-09-22T14:42:02.876544Z",
  "value" : "0Ol72qLH9JgAHUB21vCGj4ZheVokDL6unV1HIX8rWUw=",
  "userId" : "38",
  "createdOn" : "2022-09-22T14:42:02.876540Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Credential attribute value updated CredentialAttributeValue

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

409

Conflict Error

500

Internal Server error Error

Up

get /credentials/{id}/attributevalues

All credential attribute values of specific credential (credentialsIdAttributevaluesGet)

<p>Return all credential attribute values (standard and user-provided) of specific credential, query parameters can be used only if user has special permission (View and edit ALL credentials attributes value) <br> <b>Note:</b> <p>In order to get the credentialAttributeValue for any user-provided credential, a query parameter UserId must be provided in the request with GET method and the UserId should belong to the user who has provided the credentials. For example </p> <code>GET https://{{ControlRoomURL}}/v2/credentialvault/credentials/25/attributevalues?credentialAttributeId=90&userId=452</code></p>

Path parameters

id (required)

Path Parameter — Id of the credential

Query parameters

credentialAttributeId (optional)

Query Parameter — credential attribute id to which the value belongs too

userId (optional)

Query Parameter — id of the user, should be skipped for standard attribute

encryptionKey (optional)

Query Parameter — RSA public key. Used to encrypt values.

Return type

CredentialAttributeValueList

Example data

Content-Type: application/json

{
  "list" : [ {
    "password" : false,
    "updatedBy" : "38",
    "createdBy" : "38",
    "id" : "131",
    "credentialAttributeId" : "890",
    "updatedOn" : "2022-09-22T14:42:02.876544Z",
    "value" : "0Ol72qLH9JgAHUB21vCGj4ZheVokDL6unV1HIX8rWUw=",
    "userId" : "38",
    "createdOn" : "2022-09-22T14:42:02.876540Z",
    "version" : "0"
  }, {
    "password" : false,
    "updatedBy" : "38",
    "createdBy" : "38",
    "id" : "131",
    "credentialAttributeId" : "890",
    "updatedOn" : "2022-09-22T14:42:02.876544Z",
    "value" : "0Ol72qLH9JgAHUB21vCGj4ZheVokDL6unV1HIX8rWUw=",
    "userId" : "38",
    "createdOn" : "2022-09-22T14:42:02.876540Z",
    "version" : "0"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Credential attribute values found CredentialAttributeValueList

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /credentials/{id}/attributevalues

Create credential attribute values of specific credential (credentialsIdAttributevaluesPost)

Create credential attribute values for user-provided or standard attribute if user is allowed to create it

Path parameters

id (required)

Path Parameter — Id of the credential

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body CredentialAttributeValuePostList (required)

Body Parameter —

Query parameters

encryptionKey (optional)

Query Parameter — RSA public key used to encrypt the value. The key has to be encoded in Base64. Has to be retrieved from CV API ({{Control Room url}}/v2/credentialvault/keys/transport/public).

Return type

CredentialAttributeValueList

Example data

Content-Type: application/json

{
  "list" : [ {
    "password" : false,
    "updatedBy" : "38",
    "createdBy" : "38",
    "id" : "131",
    "credentialAttributeId" : "890",
    "updatedOn" : "2022-09-22T14:42:02.876544Z",
    "value" : "0Ol72qLH9JgAHUB21vCGj4ZheVokDL6unV1HIX8rWUw=",
    "userId" : "38",
    "createdOn" : "2022-09-22T14:42:02.876540Z",
    "version" : "0"
  }, {
    "password" : false,
    "updatedBy" : "38",
    "createdBy" : "38",
    "id" : "131",
    "credentialAttributeId" : "890",
    "updatedOn" : "2022-09-22T14:42:02.876544Z",
    "value" : "0Ol72qLH9JgAHUB21vCGj4ZheVokDL6unV1HIX8rWUw=",
    "userId" : "38",
    "createdOn" : "2022-09-22T14:42:02.876540Z",
    "version" : "0"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Credential attribute values created CredentialAttributeValueList

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Credentials

Up

delete /credentials/{id}

Delete credential (credentialsIdDelete)

Delete credential and all related (standard and user-provided) attributes

Path parameters

id (required)

Path Parameter — Id of the credential

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful delete

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /credentials/{id}

Get credential by id (credentialsIdGet)

Return specific credential

Path parameters

id (required)

Path Parameter — Id of the credential

Return type

Credential

Example data

Content-Type: application/json

{
  "updatedBy" : "21",
  "createdBy" : "21",
  "lockerId" : "15",
  "name" : "Sample-Credential",
  "description" : "Test Credential created from an API request",
  "attributes" : [ {
    "userProvided" : false,
    "passwordFlag" : false,
    "updatedBy" : "21",
    "createdBy" : "21",
    "masked" : true,
    "name" : "Attribute1",
    "description" : "Example attribute 1",
    "id" : "885",
    "updatedOn" : "2022-10-28T00:15:09.319988Z",
    "createdOn" : "2022-10-28T00:15:09.319987Z",
    "version" : "0"
  }, {
    "userProvided" : false,
    "passwordFlag" : false,
    "updatedBy" : "21",
    "createdBy" : "21",
    "masked" : true,
    "name" : "Attribute1",
    "description" : "Example attribute 1",
    "id" : "885",
    "updatedOn" : "2022-10-28T00:15:09.319988Z",
    "createdOn" : "2022-10-28T00:15:09.319987Z",
    "version" : "0"
  } ],
  "id" : "308",
  "updatedOn" : "2022-10-28T00:15:09.319999Z",
  "ownerId" : "21",
  "createdOn" : "2022-10-28T00:15:09.319997Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Credential Credential

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /credentials/{id}/owner/{credentialOwnerId}

Update ownership of the credential (credentialsIdOwnerCredentialOwnerIdPut)

Update ownership of the credential

Path parameters

id (required)

Path Parameter — Id of the credential

credentialOwnerId (required)

Path Parameter — Id of the new owner

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful update of credential ownership

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

409

Conflict Error

500

Internal Server error Error

Up

put /credentials/{id}

Update credential (credentialsIdPut)

Update existing credential

Path parameters

id (required)

Path Parameter — Id of the credential

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body Credential (required)

Body Parameter —

Return type

Credential

Example data

Content-Type: application/json

{
  "updatedBy" : "21",
  "createdBy" : "21",
  "lockerId" : "15",
  "name" : "Sample-Credential",
  "description" : "Test Credential created from an API request",
  "attributes" : [ {
    "userProvided" : false,
    "passwordFlag" : false,
    "updatedBy" : "21",
    "createdBy" : "21",
    "masked" : true,
    "name" : "Attribute1",
    "description" : "Example attribute 1",
    "id" : "885",
    "updatedOn" : "2022-10-28T00:15:09.319988Z",
    "createdOn" : "2022-10-28T00:15:09.319987Z",
    "version" : "0"
  }, {
    "userProvided" : false,
    "passwordFlag" : false,
    "updatedBy" : "21",
    "createdBy" : "21",
    "masked" : true,
    "name" : "Attribute1",
    "description" : "Example attribute 1",
    "id" : "885",
    "updatedOn" : "2022-10-28T00:15:09.319988Z",
    "createdOn" : "2022-10-28T00:15:09.319987Z",
    "version" : "0"
  } ],
  "id" : "308",
  "updatedOn" : "2022-10-28T00:15:09.319999Z",
  "ownerId" : "21",
  "createdOn" : "2022-10-28T00:15:09.319997Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Crednetial updated Credential

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

post /credentials/list

Search for credentials (credentialsListPost)

Search for credentials where a user is an owner or has access through a locker. If the user is locker admin returns all credentials in the system. Additional filtering, ordering and pagination rules can be requested.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Query parameters

consumed (optional)

Query Parameter — Filter credentials by fact if credential is userProvided and consumed by current user

Return type

CredentialFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 4,
    "offset" : 0
  },
  "list" : [ {
    "updatedBy" : "21",
    "createdBy" : "21",
    "lockerId" : "15",
    "name" : "Sample-Credential",
    "description" : "Test credential Created from API request",
    "attributes" : [ {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    }, {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    } ],
    "id" : "307",
    "completed" : true,
    "updatedOn" : "2022-10-12T20:42:32.896317Z",
    "ownerId" : "21",
    "createdOn" : "2022-10-12T20:42:32.896315Z",
    "version" : "6"
  }, {
    "updatedBy" : "21",
    "createdBy" : "21",
    "lockerId" : "15",
    "name" : "Sample-Credential",
    "description" : "Test credential Created from API request",
    "attributes" : [ {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    }, {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    } ],
    "id" : "307",
    "completed" : true,
    "updatedOn" : "2022-10-12T20:42:32.896317Z",
    "ownerId" : "21",
    "createdOn" : "2022-10-12T20:42:32.896315Z",
    "version" : "6"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Found credentials CredentialFilterResponse

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /credentials

Create credential (credentialsPost)

Create new instance of credential

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body CredentialPost (required)

Body Parameter —

Return type

Credential

Example data

Content-Type: application/json

{
  "updatedBy" : "21",
  "createdBy" : "21",
  "lockerId" : "15",
  "name" : "Sample-Credential",
  "description" : "Test Credential created from an API request",
  "attributes" : [ {
    "userProvided" : false,
    "passwordFlag" : false,
    "updatedBy" : "21",
    "createdBy" : "21",
    "masked" : true,
    "name" : "Attribute1",
    "description" : "Example attribute 1",
    "id" : "885",
    "updatedOn" : "2022-10-28T00:15:09.319988Z",
    "createdOn" : "2022-10-28T00:15:09.319987Z",
    "version" : "0"
  }, {
    "userProvided" : false,
    "passwordFlag" : false,
    "updatedBy" : "21",
    "createdBy" : "21",
    "masked" : true,
    "name" : "Attribute1",
    "description" : "Example attribute 1",
    "id" : "885",
    "updatedOn" : "2022-10-28T00:15:09.319988Z",
    "createdOn" : "2022-10-28T00:15:09.319987Z",
    "version" : "0"
  } ],
  "id" : "308",
  "updatedOn" : "2022-10-28T00:15:09.319999Z",
  "ownerId" : "21",
  "createdOn" : "2022-10-28T00:15:09.319997Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Credential created Credential

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Keys

Up

post /keys

Generates Public/Private key pair (keysPost)

Generate Public/Private key pair after a fresh CR installation. The generated keys are saved automatically, it needs to be done with a different endpoint. Once a key pair is saved no more keys can be generated.

Return type

Keys

Example data

Content-Type: application/json

{
  "privateKey" : "mVudD48L1JTQUtleVZhbHVlPg==",
  "publicKey" : "PD94bWwgdmVyc2lvbj0iMS4wI"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Keys are generated, body contains both Private and Public keys Keys

400

Bad Request, another key pair has already been generated and saved Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /keys/private

Check the private key status (keysPrivateGet)

Check to see if the private has been applied or not, should be used to check CredentialVault status. If Private key has been applied it means that CredentialVault is in Opened status.

Return type

PrivateKeyStatus

Example data

Content-Type: application/json

{
  "applied" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Private key status PrivateKeyStatus

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Up

put /keys/private

Use Private (Master) key to unlock CredentialVault (keysPrivatePut)

Use Private (Master) key to unlock CredentialVault after the Control Room restarts in Manual mode. Available Private key means that CredentialVault is open (connected) and the system is ready.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body PrivateKey (required)

Body Parameter — Private (Master) key is required to unlock CredentialVault in Manual mode

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Private key has been successfully applied

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /keys

Saves Public/Private key pair and Mode (keysPut)

Save Public/Private key pair and Mode after a fresh CR installation once the CR Admin user is created. The key pair to be saved needs to be generated with a different endpoint. Unpon saving the keys a Data key is generated and saved as well and CredentialVault is opened automatically.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body KeysWithMode (required)

Body Parameter — Public/Private key pair with Mode

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Keys are saved

400

Bad Request, invalid input parameters or another key pair has already been saved Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /keys/transport/public

Get RSA public key encoded with Base64. (keysTransportPublicGet)

Use this API to get RSA public key encoded with Base64. The key should be used by a client of CV API to entrypt credential values. It can be used only for create/update operations.

Return type

PublicKey

Example data

Content-Type: application/json

{
  "privateKey" : "mVudD48L1JTQUtleVZhbHVlPg=="
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Base64 encoded RSA public key PublicKey

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Lockers

Up

get /lockers/{id}/consumers

All locker's consumers (lockersIdConsumersGet)

Return all roles that can use credentials inside the locker

Path parameters

id (required)

Path Parameter — Id of the locker

Return type

LockerConsumerList

Example data

Content-Type: application/json

{
  "list" : [ {
    "id" : "id"
  }, {
    "id" : "id"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Locker consumers LockerConsumerList

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /lockers/{id}/consumers

Add locker consumer (lockersIdConsumersPost)

Make the role able to use credentials inside the locker

Path parameters

id (required)

Path Parameter — Id of the locker

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body LockerConsumer (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful creation of locker consumer

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

delete /lockers/{id}/consumers/{roleId}

Remove locker consumer (lockersIdConsumersRoleIdDelete)

Make the role no longer able to use credentials inside the locker

Path parameters

id (required)

Path Parameter — Id of the locker

roleId (required)

Path Parameter — Id of the role

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful removal of locker consumer

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

delete /lockers/{id}/credentials/{credentialId}

Remove credential from the locker (lockersIdCredentialsCredentialIdDelete)

Remove credential from the locker where you're owner or manager

Path parameters

id (required)

Path Parameter — Id of the locker

credentialId (required)

Path Parameter — Id of the credential

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Credential has been removed from the locker

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /lockers/{id}/credentials/{credentialId}

Add credential to the locker (lockersIdCredentialsCredentialIdPut)

Add your own credential to a locker where you're owner, manager or participant

Path parameters

id (required)

Path Parameter — Id of the locker

credentialId (required)

Path Parameter — Id of the credential

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Credential has been added to the locker

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /lockers/{id}/credentials

All locker's credentials (lockersIdCredentialsGet)

Return all credentials that belong to the locker filtered by permissions of current user

Path parameters

id (required)

Path Parameter — Id of the locker

Return type

CredentialAdvancedList

Example data

Content-Type: application/json

{
  "list" : [ {
    "updatedBy" : "21",
    "createdBy" : "21",
    "lockerId" : "15",
    "name" : "Sample-Credential",
    "description" : "Test credential Created from API request",
    "attributes" : [ {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    }, {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    } ],
    "id" : "307",
    "completed" : true,
    "updatedOn" : "2022-10-12T20:42:32.896317Z",
    "ownerId" : "21",
    "createdOn" : "2022-10-12T20:42:32.896315Z",
    "version" : "6"
  }, {
    "updatedBy" : "21",
    "createdBy" : "21",
    "lockerId" : "15",
    "name" : "Sample-Credential",
    "description" : "Test credential Created from API request",
    "attributes" : [ {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    }, {
      "userProvided" : false,
      "passwordFlag" : false,
      "updatedBy" : "21",
      "createdBy" : "21",
      "masked" : true,
      "name" : "Attribute1",
      "description" : "Example attribute 1",
      "id" : "885",
      "updatedOn" : "2022-10-28T00:15:09.319988Z",
      "createdOn" : "2022-10-28T00:15:09.319987Z",
      "version" : "0"
    } ],
    "id" : "307",
    "completed" : true,
    "updatedOn" : "2022-10-12T20:42:32.896317Z",
    "ownerId" : "21",
    "createdOn" : "2022-10-12T20:42:32.896315Z",
    "version" : "6"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Locker credentials CredentialAdvancedList

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

delete /lockers/{id}

Delete locker (lockersIdDelete)

Delete locker and all related user-provided attributes

Path parameters

id (required)

Path Parameter — Id of the locker

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful delete

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /lockers/{id}

Get locker by id (lockersIdGet)

Return specific locker

Path parameters

id (required)

Path Parameter — Id of the locker

Return type

Locker

Example data

Content-Type: application/json

{
  "updatedBy" : "21",
  "createdBy" : "21",
  "name" : "Locker Created via API",
  "description" : "Sample Locker Created via API request",
  "id" : "27",
  "updatedOn" : "2022-10-31T21:45:51.693652Z",
  "createdOn" : "2022-10-31T21:45:51.693647Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Locker Locker

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /lockers/{id}/members

All locker's members (lockersIdMembersGet)

Return all users that can add/remove credentials to the locker or edit the locker settings

Path parameters

id (required)

Path Parameter — Id of the locker

Return type

LockerMemberList

Example data

Content-Type: application/json

{
  "list" : [ {
    "permissions" : [ "participate", "manage", "own" ],
    "id" : "21"
  }, {
    "permissions" : [ "participate", "manage", "own" ],
    "id" : "21"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Locker members LockerMemberList

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

delete /lockers/{id}/members/{userId}

Remove locker member (lockersIdMembersUserIdDelete)

Make the user no longer able to add/remove credentials to the locker or edit the locker settings

Path parameters

id (required)

Path Parameter — Id of the locker

userId (required)

Path Parameter — Id of the user

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful removal of locker member

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /lockers/{id}/members/{userId}

Add or update a locker member (lockersIdMembersUserIdPut)

Make the user able to add/remove credentials to the locker or edit the locker settings

Path parameters

id (required)

Path Parameter — Id of the locker

userId (required)

Path Parameter — Id of the user

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body object (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successful creation/update of locker member

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

put /lockers/{id}

Update locker (lockersIdPut)

Update existing locker

Path parameters

id (required)

Path Parameter — Id of the locker

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body Locker (required)

Body Parameter —

Return type

Locker

Example data

Content-Type: application/json

{
  "updatedBy" : "21",
  "createdBy" : "21",
  "name" : "Locker Created via API",
  "description" : "Sample Locker Created via API request",
  "id" : "27",
  "updatedOn" : "2022-10-31T21:45:51.693652Z",
  "createdOn" : "2022-10-31T21:45:51.693647Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Locker updated Locker

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

post /lockers/list

Search for lockers (lockersListPost)

Search for lockers where the current user is a member (owner, manager or participant) or has usage permission. If the user is locker admin returns all lockers in the system. Additional filtering, ordering and pagination rules can be requested. The result includes locker members and count of credentials inside each locker.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

LockerFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 4,
    "offset" : 0
  },
  "list" : [ "", "" ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Found lockers LockerFilterResponse

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /lockers

Create a locker (lockersPost)

Create a new instance of a locker

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body LockerPost (required)

Body Parameter —

Return type

Locker

Example data

Content-Type: application/json

{
  "updatedBy" : "21",
  "createdBy" : "21",
  "name" : "Locker Created via API",
  "description" : "Sample Locker Created via API request",
  "id" : "27",
  "updatedOn" : "2022-10-31T21:45:51.693652Z",
  "createdOn" : "2022-10-31T21:45:51.693647Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Locker created Locker

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

409

Conflict Error

500

Internal Server error Error

LoginSetting

Up

put /loginsetting

Create or update device login setting (loginsettingPut)

Use this API to set login credentials for a user to acquire session on the device when a bot is deployed.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body LoginSettingPut (required)

Body Parameter — Credentials to acquire user session on the device

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Credentials updated for 'user'

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Mode

Up

get /mode

Get current CredentialVault mode (modeGet)

CredentialVault can be in Express or Manual modes. Requires Admin rights to execute this API.

Return type

Mode

Example data

Content-Type: application/json

{
  "name" : "Manual"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

CV Mode has been successfully received Mode

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /mode

Update CredentialVault mode to Express or Manual (modePut)

In Manual mode the system will require input of Private (Master) key after CR restart, it's required to unlock CredentialVault

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body ModePut (required)

Body Parameter — New mode to set CredentialVault to

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Mode has been successfully set

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Models

Methods

Table of Contents

Credential
CredentialAdvanced
CredentialAdvancedList
CredentialAttribute
CredentialAttributePost
CredentialAttributeValue
CredentialAttributeValueList
CredentialAttributeValuePost
CredentialAttributeValuePostList
CredentialAttributeValuePut
CredentialFilterResponse
CredentialPost
Error
Filter
FilterRequest
Keys
KeysWithMode
Locker
LockerAdvanced
LockerConsumer
LockerConsumerList
LockerFilterResponse
LockerMember
LockerMemberList
LockerMemberPermissions
LockerPost
LoginSettingPut
Mode
ModeName
ModePut
Ops
PageRequest
PageResponse
PrivateKey
PrivateKeyStatus
PublicKey
Sort

`Credential` Up

id (optional)

String ID of credential

example: 308

name

String Name of credential

example: Sample-Credential

description (optional)

String Description of credential

example: Test Credential created from an API request

lockerId (optional)

String Id of the locker which has this credential, can be null if the credential is not assigned to any locker

example: 15

ownerId (optional)

String Id of Credential owner User

example: 21

attributes (optional)

array[CredentialAttribute]

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-28T00:15:09.319997Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Date when it was the latest update of the object

example: 2022-10-28T00:15:09.319999Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

`CredentialAdvanced` Up

id (optional)

String Id of credential

example: 307

name

String Name of credential

example: Sample-Credential

description (optional)

String Description of credential

example: Test credential Created from API request

completed (optional)

Boolean A flag to indicate if consumer(s) needs to provide a value for user-provided attribute or not

lockerId (optional)

String Id of the locker which has this credential, can be null if the credential is not assigned to any locker

example: 15

ownerId (optional)

String Id of Credential owner User

example: 21

attributes (optional)

array[CredentialAttribute]

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-12T20:42:32.896315Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Latest updated date of the object

example: 2022-10-12T20:42:32.896317Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 6

`CredentialAdvancedList` Up

A wrapper on array of credentials

list (optional)

array[CredentialAdvanced]

`CredentialAttribute` Up

id (optional)

String Id of credential attribute

example: 885

name

String Name of credential attribute

example: Attribute1

description (optional)

String Description of credential attribute

example: Example attribute 1

userProvided (optional)

Boolean A flag to indicate if the credential attribute is user-provided or common

example: false

masked (optional)

Boolean A flag to indicate if the credential attribute value is masked

example: true

passwordFlag (optional)

Boolean A flag to indicate if the credential attribute used for password is a masked input fields

example: false

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-28T00:15:09.319987Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Latest updated date of the object

example: 2022-10-28T00:15:09.319988Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

`CredentialAttributePost` Up

name

String Name of credential attribute

example: Username

description (optional)

String Description of credential attribute

example: Username for a sample

userProvided (optional)

Boolean A flag to configure whether the attribute requires a user's input (true) or is standard for all users (false).

example: false

masked (optional)

Boolean A flag to configure whether the attribute value is masked with asterisks (true) or is visible to users (false)

example: true

passwordFlag (optional)

Boolean A flag to indicate if the credential attribute used for password are masked input fields

example: true

`CredentialAttributeValue` Up

id (optional)

String Id of credential attribute value

example: 131

credentialAttributeId

String Id of credential attribute

example: 890

value

String Value of credential attribute

example: 0Ol72qLH9JgAHUB21vCGj4ZheVokDL6unV1HIX8rWUw=

userId (optional)

String Id of user to which the value belongs to

example: 38

createdBy (optional)

String Id of the user who created the object

example: 38

createdOn (optional)

String Date when the object got created

example: 2022-09-22T14:42:02.876540Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 38

updatedOn (optional)

String Latest updated date of the object

example: 2022-09-22T14:42:02.876544Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

password (optional)

Boolean Flag to indicate if there is a password set to the Credential

example: false

`CredentialAttributeValueList` Up

A wrapper on array of credential attribute values

list (optional)

array[CredentialAttributeValue]

`CredentialAttributeValuePost` Up

credentialAttributeId

String Id of credential attribute

example: 890

value

String Value of credential attribute

example: aVerySecurePassword

`CredentialAttributeValuePostList` Up

A wrapper on array of credential attribute values

list (optional)

array[CredentialAttributeValuePost]

`CredentialAttributeValuePut` Up

value

String Value of credential attribute

example: aVerySecurePassword

version

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

`CredentialFilterResponse` Up

page (optional)

PageResponse

list (optional)

array[CredentialAdvanced]

`CredentialPost` Up

name

String Name of credential

description (optional)

String Description of credential

attributes (optional)

array[CredentialAttributePost]

`Error` Up

code (optional)

String Error code

message (optional)

String Message describing error

details (optional)

String More details of the error message

correctiveAction (optional)

String Corrective action to be taken to get rid of this error.

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

and

lt

le

eq

ne

ge

gt

substring

NONE

or

not

operands (optional)

array[Ops]

example: [{operator=gt, field=createdOn, value=2022-10-12T00:00:00.123Z}, {operator=lt, field=createdOn, value=2022-10-12T23:00:00.123Z}]

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`Keys` Up

privateKey

String Encrypted Private key

example: mVudD48L1JTQUtleVZhbHVlPg==

publicKey

String Encrypted Public key

example: PD94bWwgdmVyc2lvbj0iMS4wI

`KeysWithMode` Up

privateKey

String Encrypted Private key

example: mVudD48L1JTQUtleVZhbHVlPg==

publicKey

String Encrypted Public key

example: PD94bWwgdmVyc2lvbj0iMS4wI

mode

ModeName

`Locker` Up

id (optional)

String Id of the locker

example: 27

name

String Name of locker

example: Locker Created via API

description (optional)

String Description of locker

example: Sample Locker Created via API request

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-31T21:45:51.693647Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Latest updated date of the object

example: 2022-10-31T21:45:51.693652Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

`LockerAdvanced` Up

id (optional)

String Id of the locker

example: 27

name

String Name of locker

example: Locker Created via API

description (optional)

String Description of locker

example: Sample Locker Created via API request

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-31T21:45:51.693647Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Latest updated date of the object

example: 2022-10-31T21:45:51.693652Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

members (optional)

array[LockerMember] All members of locker

countOfCredentials (optional)

BigDecimal Count of credentials inside locker

`LockerConsumer` Up

id (optional)

String Id of role

`LockerConsumerList` Up

A wrapper on array of locker consumers

list (optional)

array[LockerConsumer]

`LockerFilterResponse` Up

page (optional)

PageResponse

list (optional)

array[LockerAdvanced]

`LockerMember` Up

id (optional)

String Id of user

example: 21

permissions (optional)

LockerMemberPermissions

`LockerMemberList` Up

A wrapper on array of locker members

list (optional)

array[LockerMember]

`LockerMemberPermissions` Up

Locker specific actions a given user is allowed to perform

`LockerPost` Up

name

String Name of locker

example: Locker Created via API

description (optional)

String Description of locker

example: Sample Locker Created via API request

`LoginSettingPut` Up

loginUsername

String Login username (username or domain\username). To enter details for AD Control Rooms, use the domain\username format. When using an API client that does not support the domain\username format, you can add an additional backslash character to the username. This will escape the backslash character and prevent it from being interpreted as a special character by the API client. For example, domain\\username.