Configure Certificate Authority

Configure Certificate Authority

Update the configuration of a Certificate Authority

Request
URI
PATCH
https://{api_host}/v1/certificate-authorities
COPY
Request Body
CertificateAuthorityCreationSpec of type(s) application/json
Required
{
    "openSSLCertificateAuthoritySpec": {
        "commonName": "OpenSSL CA",
        "country": "IN",
        "state": "Karnataka",
        "locality": "Bengaluru",
        "organization": "VMware Inc.",
        "organizationUnit": "VCF"
    },
    "microsoftCertificateAuthoritySpec": {
        "username": "Administrator",
        "secret": "********",
        "serverUrl": "https://sfo-ad.rainpole.io/certsrv",
        "templateName": "WebServer"
    }
}
object
openSSLCertificateAuthoritySpec
Optional

This specification contains OpenSSL CA configuration details

object
microsoftCertificateAuthoritySpec
Optional

This specification contains Microsoft CA configuration details

Responses
200

Ok

Operation doesn't return any data structure

400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


404

Not Found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'