Venafi Authenticate¶

Overview¶

You can use the Venafi Authenticate API to authenticate a Venafi Trust Protection Platform (TPP) server. This is an optional check.

REST Endpoint: /mgmt/cm/adc-core/external-ca/venafi/authenticate¶

Requests¶

POST /mgmt/cm/adc-core/external-ca/venafi/authenticate¶

Send a POST to the endpoint to authenticate a Venafi Trust Protection Platform (TPP) server.

Request Parameters¶

The JSON in the body of the POST request can contain the following parameters.

Name	Type	Required	Description
apiEndpoint	string	True	URL of a Venafi Trust Protection Platform (TPP) server
userName	string	True	Venafi Server user name
password	string	True	Venafi Server password

Query Parameters¶

None

Response¶

The JSON in the POST’s response can include the following parameters.

HTTP/1.1 200 OK

Name	Type	Description
userName	string	Venafi Server user name
apiEndpoint	string	URL of a Venafi Trust Protection Platform (TPP) server
apiKey	string	UUID
selfLink	string	URL of authentication

Permissions¶

Role	Allow
admin	Yes
Certificate Editor/Viewer	No

Examples¶

POST to authenticate¶

The following example authenticates a Venafi TPP server.

POST https://<BIG-IQ>/mgmt/cm/adc-core/external-ca/venafi/authenticate

The JSON in the body of the request can look similar to the following.

{
    "apiEndpoint": "https://101018183.dev.lab.venafi.com/VEDSDK",
    "userName": "<Venafi Server User Name>",
    "password": "<Venafi Server Password>"
}

Response¶

HTTP/1.1 200 OK

The JSON in the body of the response can look similar to the following.

{
    "username": "<Venafi Server User Name>",
    "apiEndpoint": "https://101018183.dev.lab.venafi.com/VEDSDK",
    "apiKey": "6ab6b8a3-bbde-812d-4970-a295ea5a7882",
    "generation": 0,
    "lastUpdateMicros": 0,
    "kind": "cm:adc-core:external-ca:venafi:authenticate:venafiauthenticationstate",
    "selfLink": "https://localhost/mgmt/cm/adc-core/external-ca/venafi/authenticate"
}

Previous Next