GET Credentials/Connector/Adaptable/{guid}

Returns information about an Adaptable Credential Connector that is 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
{guid}

Specify this parameter as part of the URL. The unique identifier of the Adoptable Credential Connector. To get the GUID, call POST Config/DnToGuid and pass the connector path. For example: \VED\Credentials\[connector name].

Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}.

Returns

Response description

Name

Description

HTTP 200

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

  • AllowedIdentities: An array of GUIDS that identify people or groups from an identity provider. The local, AD and LDAP identities who can use the connector.

  • ConnectorName: The name of the Adaptable Credential connector you want to create.

  • Description: Appears only if there is a value.

  • 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.ServiceCredentialThe location of credential that you created for the vault. Specify the Distinguished Name (DN) for example, \\VED\\Policy\\Credentials\\HCToken"

  • Success: true: Appears only if the API call succeeded.

HTTP 500

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

  • Error: The reason for failure.

  • Success: false: The request was invalid.

Example: Find information about an Adaptable Credential Connector

Request

GET https://tpp.venafi.example/vedsdk/Credentials/Connector/Adaptable/{30565066-f
9b2-44c2-adf0-5d957583d903}
  
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK
{
   "AllowedIdentities":[
      "local:{f26083d6-d5e6-4e76-a032-dd9dd8b19163}"
   ],
   "PowershellScript":"HashiCorp Vault.ps1",
   "ServiceAddress":"https://syslog2.drivers.venqa.venafi.com",
   "ServiceCredential":"\\VED\\Policy\\Credentials\\MyCredential",
   "Success":true
}