Register a new credential
Register a new credential
Credential to register
|
type
string
requiredThe type of these credentials
Value
raw
|
||
|
secret
object (Secret String)
required
The raw secret (JSON or otherwise) |
||
|
||
|
name
string
requiredName of the credentials |
||
|
target
string (CredentialTarget)
required
Enum
akv
aws
gcp
ldap
openid
rest
ssh
stream
|
||
|
description
string
A description of the credentials |
||
|
expires
string
The expiration date of these credentials |
||
|
triggers
object (TriggersCredentials)
|
||
|
||
|
type
string
requiredThe type of these credentials
Value
password
|
||
|
login
string
requiredThe login of these credentials |
||
|
name
string
requiredName of the credentials |
||
|
target
string (CredentialTarget)
required
Enum
akv
aws
gcp
ldap
openid
rest
ssh
stream
|
||
|
password
object (Secret String)
The password of these credentials. On update, the stored password is kept when this field is omitted |
||
|
||
|
description
string
A description of the credentials |
||
|
expires
string
The expiration date of these credentials |
||
|
triggers
object (TriggersCredentials)
|
||
|
||
|
type
string
requiredThe type of these credentials
Value
x509
|
||||||
|
store
object (Certificate And Key Storage)
required
The PKCS#12 certificate |
||||||
|
||||||
|
name
string
requiredName of the credentials |
||||||
|
target
string (CredentialTarget)
required
Enum
akv
aws
gcp
ldap
openid
rest
ssh
stream
|
||||||
|
expires
string
Ignored on submission. The server sets it to the expiration date of the certificate |
||||||
|
description
string
A description of the credentials |
||||||
|
triggers
object (TriggersCredentials)
|
||||||
|
||||||
|
type
string
requiredThe type of these credentials
Value
ssh
|
||
|
login
string
requiredThe SSH login |
||
|
name
string
requiredName of the credentials |
||
|
target
string (CredentialTarget)
required
Enum
akv
aws
gcp
ldap
openid
rest
ssh
stream
|
||
|
key
object (Secret String)
The SSH key. On update, the stored key is kept when this field is omitted |
||
|
||
|
description
string
A description of the credentials |
||
|
expires
string
The expiration date of these credentials |
||
|
triggers
object (TriggersCredentials)
|
||
|
||
-
201 Credential successfully registered
application/jsonidstring requiredThe internal ID of the credentials
typestring requiredThe type of these credentials
Valuerawsecretobject (Secret String) requiredThe raw secret (JSON or otherwise)
clearstringThe clear value of the secret
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamdescriptionstringA description of the credentials
expiresstringThe expiration date of these credentials
triggersobject (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
idstring requiredThe internal ID of the credentials
typestring requiredThe type of these credentials
Valuepasswordloginstring requiredThe login of these credentials
passwordobject (Secret String) requiredThe password of these credentials
clearstringThe clear value of the secret
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamdescriptionstringA description of the credentials
expiresstringThe expiration date of these credentials
triggersobject (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
idstring requiredThe internal ID of the credentials
typestring requiredThe type of these credentials
Valuex509storeobject requiredThe certificate of these credentials. The private key is never returned
certificatestring requiredThe PEM-encoded certificate
keyPairobject requiredAlways empty in responses, the private key is never returned
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamexpiresstringThe expiration date of the certificate. Computed by the server from the certificate
descriptionstringA description of the credentials
triggersobject (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
idstring requiredThe internal ID of the credentials
typestring requiredThe type of these credentials
Valuesshloginstring requiredThe SSH login
keyobject (Secret String) requiredThe SSH key
clearstringThe clear value of the secret
namestring requiredName of the credentials
targetstring (CredentialTarget) requiredEnumakvawsgcpldapopenidrestsshstreamdescriptionstringA description of the credentials
expiresstringThe expiration date of these credentials
triggersobject (TriggersCredentials)onCredentialsExpirationarray of stringNotifications to execute on credentials expiration
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCREDENTIALS-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Credentialstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid CredentialsdetailstringA 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
ValueCREDENTIALS-004messagestring requiredA short, human-readable summary of the problem type
ValueCredentials already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCredentials already existsdetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring 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
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 privilegesdetailstringA 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 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