List the existing credential(s)
List the existing credential(s)
|
type
string (CredentialType)
Restrict the list to a specific type of credentials
Enum
x509
raw
password
ssh
|
|
target
string (CredentialProvider)
Restrict the list to credentials targeting a specific type of object
Enum
akv
aws
gcp
s3
|
-
200 Credential(s) list
application/jsonArray [
typestring requiredThe type of these credentials
Valuerawsecretobject (Secret String) requiredThe raw secret (JSON or otherwise)
clearstring | nullThe clear value of the secret
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamdescriptionstring | nullA description of the credentials
expiresstring | nullThe expiration date of these credentials
triggersobject | null (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
typestring requiredThe type of these credentials
Valuepasswordloginstring requiredThe login of these credentials
passwordobject (Secret String) requiredThe password of these credentials
clearstring | nullThe clear value of the secret
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamdescriptionstring | nullA description of the credentials
expiresstring | nullThe expiration date of these credentials
triggersobject | null (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
typestring requiredThe type of these credentials
Valuex509storeobject (Secret String) requiredThe PKCS#12 certificate
clearstring | nullThe clear value of the secret
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamdescriptionstring | nullA description of the credentials
expiresstring | nullThe expiration date of these credentials
triggersobject | null (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
typestring requiredThe type of these credentials
Valuesshloginstring requiredThe SSH login
keyobject (Secret String) requiredThe SSH key
clearstring | nullThe clear value of the secret
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamdescriptionstring | nullA description of the credentials
expiresstring | nullThe expiration date of these credentials
triggersobject | null (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
]
-
204 No credential defined
-
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-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-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
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
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCREDENTIALS-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