Retrieve a certificate
Retrieve an OpenSSH certificate based on its id
id
string
requiredThe Id of the certificate to retrieve |
-
200 The certificate with the associated permissions
application/jsoncertificateobject (SSHCertificate) requiredsigningCastring requiredThe Signing CA identifier
idstring (Internal ID) requiredObject internal ID
castring requiredName of the OpenSSH Certificate Authority the certificate is enrolled on
certificatestring (OpensshCertificate) requiredtypestring (SSHCertificateType) requiredThe Type of OpenSSH certificate
EnumUSER
HOST
serialstring requiredThe serial number of the certificate
principalsarray of string requiredHostnames covered by the certificate
validAfterstring requiredThe start of the validity period of the certificate
validBeforestring requiredThe end of the validity period of the certificate
publicKeyThumbprintstring requiredThe thumbprint of the public key of the certificate
revokedboolean requiredIf true, the certificate is revoked
keyIdstring requiredtemplatestringName of the Template the certificate is enrolled on
revocationDatestring | nullThe revocation date of the certificate
permissionsobject (Permissions) requiredrevokeboolean requiredIs the user allowed to revoke the certificate or not
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001
messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected error
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected error
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002
messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not exist
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not exist
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009
messagestring requiredA short, human-readable summary of the problem type
ValueAuthentication expired
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueAuthentication expired
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-010
messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expired
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expired
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueLIC-001
messagestring requiredA short, human-readable summary of the problem type
ValueInvalid License
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid License
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002
messagestring requiredA short, human-readable summary of the problem type
ValueExpired License
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired License
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-003
messagestring requiredA short, human-readable summary of the problem type
ValueModule is not entitled
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueModule is not entitled
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSSH-CERT-004
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate not found
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate not found
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSSH-CERT-001
messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Error
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Error
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001
messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected error
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected error
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807