List the existing key(s) on a keystore
List the existing key(s) on a keystore
keystoreName
string
requiredThe Keystore's name |
unusedOnly
boolean | null
List only keys that are not used anywhere |
-
200 Private key(s) list
application/jsonArray [
namestring requiredThe Private Key's name
keystorestring requiredThe Keystore's name on which this Key is stored
descriptionobject (Key Description) requiredCryptographic information about a Private Key
typestring requiredThe type of cryptographic algorithms allowed on this Key
Valuesuiteb
keyTypestring requiredThe algorithm type of the Key
Enumec
ed
rsa
keySizeinteger | nullThe Key's size for an RSA Key
keyECParameterstring | nullThe Key's curve for an Elliptic-curve Key
Enumsecp256r1
secp384r1
secp521r1
keyEDParameterstring | nullThe Key's curve for an Edwards-curve Key
EnumED25519
ED448
extractableboolean requiredIf true, this Key can be extracted from the Keystore
aliasstring | nullThe Private Key's alias
modifiableboolean | nullIf true, this Key can be extracted from the Keystore
enforcedHashAlgorithmobject | nullThis Key's Hash Algorithm
EnumSHA1
SHA224
SHA256
SHA384
SHA512
SHA3_224
SHA3_256
SHA3_384
SHA3_512
]
-
204 No key defined
-
401 Unauthorized request
application/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 account does not exist
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or account 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-003
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trusted
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusted
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-004
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expired
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is 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-005
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revoked
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revoked
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/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
ValueSEC-PERM-001
messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privileges
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privileges
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/jsonerrorstring requiredThe error code of the problem
ValueKEYSTORE-003
messagestring requiredA short, human-readable summary of the problem type
ValueKeystore not found
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueKeystore not found
detailstring | 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
ValueKEY-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
ValueKEYSTORE-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