Get Certificate Authority By Id

Get Certificate Authority By Id

Get certificate authority information

Request
URI
GET
https://{api_host}/v1/certificate-authorities/{id}
COPY
Path Parameters
string
id
Required

The CA type

id example
One among: OpenSSL, Microsoft

Responses
200

Ok

Returns CertificateAuthority of type(s) application/json
{
    "id": "One among: OpenSSL, Microsoft",
    "username": "Administrator",
    "serverUrl": "https://sfo-ad.rainpole.io/certsrv",
    "templateName": "WebServer",
    "commonName": "OpenSSL CA",
    "country": "IN",
    "state": "Karnataka",
    "locality": "Bengaluru",
    "organization": "VMware Inc.",
    "organizationUnit": "VCF"
}
string
id
Required

CA type. Only supports Microsoft and OpenSSL CAs

string
username
Optional

Microsoft CA server username

string
serverUrl
Optional

Microsoft CA server url

string
templateName
Optional

Microsoft CA server template name

string
commonName
Optional

OpenSSL CA domain name

string
country
Optional

ISO 3166 country code where company is legally registered

string
state
Optional

The full name of the state where company is legally registered

string
locality
Optional

The city or locality where company is legally registered

string
organization
Optional

The name under which company is legally registered

string
organizationUnit
Optional

Organization with which the certificate is associated


404

Not Found

Returns Error of type(s) application/json
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.