Search for OpenSSH certificates
Search for openssh certificates using a certificate search query
The certificate search query
|
query
string | null
A SSHSCQL query to filter the certificates |
|||
|
fields
array of string | null
The fields that must be present in the response |
|||
|
sortedBy
array of objects | null (Sort By)
How to sort the results |
|||
|
Array [
] |
|||
|
pageIndex
integer | null
Request the page at defined index |
|||
|
pageSize
integer | null
The number of results per request |
|||
|
withCount
boolean | null
Add the number of results to the search results |
|||
-
200 The certificate search results
application/jsonresultsarray of objects (OpenSSH Certificate Search Result) requiredThe list of certificates
Array [
idstring (Internal ID) requiredObject internal ID
castring requiredName of the OpenSSH Certificate Authority the certificate is enrolled on
templatestring requiredName of the Template the certificate is enrolled on
certificatestring (OpensshCertificate) requiredtypestring (SSHCertificateType) requiredThe Type of OpenSSH certificate
EnumUSERHOSTserialstring 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 requiredpermissionsobject | null (Permissions)The user's permissions on this certificate
revokeboolean requiredIs the user allowed to revoke the certificate or not
revocationDatestring | nullThe revocation date of the certificate
]
pageIndexinteger requiredThe current page index
pageSizeinteger requiredThe current page size
hasMoreboolean requiredtrue while the page is not the last, else false
countinteger | nullThe total number of results. Only available if withCount was requested
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSSH-CERT-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid search querytitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid search querydetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSTREAMQL-001messagestring requiredA short, human-readable summary of the problem type
ValueInvalid StreamQL Querytitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid StreamQL Querydetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/problem+jsonerrorstring 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
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-009messagestring requiredA short, human-readable summary of the problem type
ValueAuthentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueAuthentication 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-010messagestring 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/problem+jsonerrorstring requiredThe error code of the problem
ValueLIC-001messagestring 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-002messagestring 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
errorstring requiredThe error code of the problem
ValueLIC-003messagestring requiredA short, human-readable summary of the problem type
ValueModule is not entitledtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueModule is not entitleddetailstring | 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-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