Aggregate OpenSSH certificates
Aggregate on OpenSSH certificates using a certificate aggregation query
The certificate aggregation query
|
query
string
The SSHSCQL query to use for the search, represents the way to filter certificates. If not specified, it will filter nothing |
|||
|
groupBy
array of string
The field that the aggregation will take place on |
|||
|
withCount
boolean
If set to true, the total count of certificates matching the SSHSCQL query will be returned |
|||
|
sortOrder
string
Enum
Asc
Desc
KeyAsc
KeyDesc
|
|||
|
limit
integer
In case of an aggregate sending a lot of different results, how many must be sent back |
|||
|
having
object (Having)
A condition to apply to the result. Only the aggregates results with more than 5 certificates in them can be kept for example |
|||
|
|||
-
200 The aggregation result
application/jsonitemsarray of object requiredAll the groups in this aggregate
Array [
_idobjectThe object containing this group's information
groupedByFieldstringThis field has the requested aggregate field as key, and the value for this group as value
countintegerThe number of certificates in this group
]
countintegerThe total number of certificates matching the query
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSSH-CERT-003messagestring requiredA short, human-readable summary of the problem type
ValueInvalid aggregate querytitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid aggregate querydetailstringA 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 QuerydetailstringA 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 ProviderdetailstringA 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 errordetailstringA 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 existdetailstringA 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 expireddetailstringA 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 expireddetailstringA 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 LicensedetailstringA 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 LicensedetailstringA 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 entitleddetailstringA 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 ErrordetailstringA 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 errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807