List the existing PKI connector(s)
List the existing PKI connector(s)
-
200 PKI connector list
application/jsonArray [
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuestreamendPointstring requiredStream's base endpoint
templatestring requiredStream's certificate template to use for enrollment
castring requiredStream's technical name of the CA on which to enroll
loginCredentialsstring | nullName of the password credentials to use to authenticate on the PKI
authenticationCredentialsstring | nullName of the certificate credentials to use to authenticate on the PKI
timeoutstring | nullproxystring | nullqueuestring | null_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueawsacmpcaregionstring requiredcaArnstring requiredaccessCredentialsstring | nullName of the password credentials containing Access Key Id and Secret Access Key. If not defined, an account present in environment variables can be used.
templateArnstring | nullroleArnstring | nullvalidDaysstring | nullretryIntervalstring | nullsigningHashstring | nullcertificateUsagestring | nullcaPolicyOidstring | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuecerteuropeendPointstring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
offerIdstring requiredorganizationIdstring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
revReasonstring | nullretryIntervalstring | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuecmpendPointstring requiredprofilestring requiredissuerCADNstring requiredissuerCACertstring requiredsignerCredentialsstring requiredName of the certificate credentials to use to sign on the PKI
authenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
emailMapstring | nullsanDnsMapstring | nullcnMapstring | nullprofileMapstring | nullissuerMapstring | nulllegacyCMPStyleboolean | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuedigicertendPointstring requiredapiCredentialsstring requiredName of the raw credentials containing the API key to authenticate on the PKI
organizationIdinteger requiredcaCertIdstring | nullretryIntervalstring | nullskipApprovalboolean | nullcustomConnectorDataMappingobject | nullproperty name*stringadditional propertytimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueejbcaendPointstring requiredprofilestring requiredcaNamestring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
eeProfilestring | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueentrustloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
certTypestring requiredrequesterDefaultMailstring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
requesterNamestring | nullrequesterPhonestring | nullcertLifetimestring | nullclientIdinteger | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueintegratedcaKeyobject | null (models.secret.SecretString)valuestring | nullValue of the secret that will be passed to Horizon
caCertstring | nullcrlPathstring | nullcrlLifetimestring | nullcertTypestring | nullsignAlgstring | nullcrtLifetimestring | nullcrtBackDatestring | nullcheckPopboolean | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuefcmsendPointstring requiredapiCredentialsstring requiredName of the raw credentials containing the API key to authenticate on the PKI
templateIdinteger requireddefaultOwnerstring requiredauthenticationDomainIdinteger requireddeleteOnRevokeboolean requiredownerGroupsstring | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuegsatlasloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
authenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
hashAlgorithmstring | nullcertificateUsagestring | nullretryIntervalstring | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuegsmsslendpointTypestring requiredprofilestring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
domainIdstring requiredcertificateValidityinteger | nulldefaultEmailstring | nulldefaultPhonestring | nullretryIntervalstring | nulltimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueotpkiendPointstring requiredprofilestring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
emailMapstring | nullsanDnsMapstring | nullsanEmailMapstring | nulluidMapstring | nullzonestring | nullzoneLabelstring | nullThe name of the label where the zone value is stored on an enrolled certificate
timeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuemsadcsendPointstring requiredprofilestring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
enrollmentCredentialsstring requiredName of the certificate credentials to use to enroll on the PKI
timeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueevtadcsendPointstring requiredcaConfigstring requiredprofilestring requireddomainstring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
enrollmentCredentialsstring requiredName of the certificate credentials to use to enroll on the PKI
timeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuenexuscmendPointstring requiredendPointIssuingCAstring requiredprocedurestring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
timeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuenameshieldapiCredentialsstring requiredName of the api-key credentials to use to authenticate on the PKI
environmentstring requiredThe testing environment will use https://ote-api.nameshield.net endpoint and the production will use https://api.nameshield.net
EnumproductiontestingorganizationIdstring requiredproductIdstring requiredcustomerIdstring requiredtimeoutstring | nullproxystring | nullqueuestring | nullstatusobject | null (PKI Connector status)The status of a pki connector
lastCheckinteger requiredThe check date, in milliseconds since the epoch, of the last time the pki connector health check was ran.
statusstring requiredThe status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.
Enumsuccessfailureunknownrunningmessagestring | nullA meaningful message about the result of the health check (in case of error)
]
-
204 No PKI connector defined or insufficient permissions
-
401 Unauthorized request
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect pathtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect pathdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/jsonerrorstring requiredThe error code of the problem
ValuePKI-CONNECTOR-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807