PUT Credentials/Connector/Adaptable/{guid}

Updates an Adaptable Credential Connector in VCC.

Requirements

  • Permissions:  The caller must have Master Admin permission.
  • Token scope:  Security:Manage

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

AllowedIdentities

(Optional) An array of GUIDs that identify people or groups who have admin permissions or permissions to the Credentials tree. From Trust Protection Platform, the local, AD, and LDAP identities who can use the connector.

TIP  Always verify that the identity has either admin permissions or permissions to the Credentials tree. Otherwise, a future credential that uses this connector may be unusable or hidden. To get this information, call POST Identity/Browse.

ConnectorName

Immutable. The name of the Adaptable Credential connector you want to create.
Description (Optional) The purpose of the connector.

PowershellScript

The Adaptable Credential PowerShell script name. The script must be in [installation folder]\Venafi\Scripts\AdaptableCredential.

ServiceAddress The vault address, for example, https://syslog2.drivers.venqa.venafi.com.
ServiceCredential The location of credential that you created for the vault. Specify the Distinguished Name (DN) for example, \\VED\\Policy\\Credentials\\HCToken"

Returns

Returns Success or Error.

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

Success: true: This API call created the Adaptable Credential Connector, and then performed an IIS reset.

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • Error: The reason for the error.

  • Success: false: The request was invalid.

Example: Change the service address and add a description

Request

PUT https://tpp.venafi.example/vedsdk/Credentials/Connector/Adaptable/{30565066-f9b2-44c2-adf0-5d957583d903} 
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "AllowedIdentities":[
      "local:{f26083d6-d5e6-4e76-a032-dd9dd8b19163}"
   ],
   "Description":"This connector is for HV91",
   "PowershellScript":"HashiCorp Vault",
   "ServiceAddress":"https://syslog2.drivers.venqa.venafi.com",
   "ServiceCredential":"\\VED\\Policy\\Credentials\\MyCredential",
}

Response

HTTP/1.1 200 OK
{
  "Success": true
}