POST Certificates/Associate
Allows one or more Application objects of devices to use an existing certificate. Optionally, Certificates/Associate can launch certificate provisioning. After the association between the Certificate and Application object is complete:
-
The certificate with a 'Provisioning' Management type is ready to install on a device. If PushToNew is true and the certificate is currently in a state that allows provisioning (not disabled, not in error, nor already in process), provisioning to the newly associated device begins.
- Additional information appears on the Associations tab of the Application object.
Requirements
- Permissions: The caller must have Write permission to the Certificate Distinguished Name (Certificate DN) object. The caller must also have Write permission or Associate permission and Delete permission to relevant Application objects.
- Token scope: Certificate: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
Name |
Description |
---|---|
ApplicationDN | An array of one or more Application objects, specified by their distinguished names, that uniquely identify them in the Venafi platform. |
CertificateDN |
The Distinguished Name (DN) of the certificate. |
PushToNew |
An additional provision action for the certificate:
|
Returns
Name |
Description |
---|---|
HTTP 200 |
For valid requests, this call returns a HTTP 200 message and the following data in the message body:
|
HTTP 400 |
For invalid requests, this call returns a HTTP 400 BadRequest and the following data in the message body:
|
Example: Associate an application with a certificate
Request
POST https://tpp.venafi.example/vedsdk/Certificates/Associate Authorization:Bearer 4MyGeneratedBearerTknz== { "CertificateDN":"\\VED\\Policy\\CertificateSet\\Cert75G-Lab04", "ApplicationDN":[ "\\VED\\Policy\\CertificateSet\\HSM95\\F5 LTM Advanced" ], "PushToNew":"true" }
Response
HTTP/1.1 200 OK { "Success":true }