Register a new credential
Register a new credential
Credential to register
|
type
string
requiredThe type of these credentials
Value
json
|
|||
|
json
object (Secret String)
required
The JSON secret |
|||
|
|||
|
id
string (Internal ID)
requiredObject internal ID |
|||
|
name
string
requiredName of the credentials |
|||
|
target
string
requiredThe targeted objects for these credentials
Enum
akv
aws
gcp
ldap
|
|||
|
description
string | null
A description of the credentials |
|||
|
expires
string | null
The expiration date of these credentials |
|||
|
type
string
requiredThe type of these credentials
Value
text
|
|||
|
login
string
requiredThe login of these credentials |
|||
|
password
object (Secret String)
required
The password of these credentials |
|||
|
|||
|
id
string (Internal ID)
requiredObject internal ID |
|||
|
name
string
requiredName of the credentials |
|||
|
target
string
requiredThe targeted objects for these credentials
Enum
akv
aws
gcp
ldap
|
|||
|
description
string | null
A description of the credentials |
|||
|
expires
string | null
The expiration date of these credentials |
|||
-
201 Credential successfully registered
application/jsontypestring requiredThe type of these credentials
Valuejsonjsonobject (Secret String) requiredThe JSON secret
clearstring | nullThe clear value of the secret
securestring | nullThe hidden value of the secret
idstring (Internal ID) requiredObject internal ID
namestring requiredName of the credentials
targetstring requiredThe targeted objects for these credentials
Enumakvawsgcpldapdescriptionstring | nullA description of the credentials
expiresstring | nullThe expiration date of these credentials
typestring requiredThe type of these credentials
Valuetextloginstring requiredThe login of these credentials
passwordobject (Secret String) requiredThe password of these credentials
clearstring | nullThe clear value of the secret
securestring | nullThe hidden value of the secret
idstring (Internal ID) requiredObject internal ID
namestring requiredName of the credentials
targetstring requiredThe targeted objects for these credentials
Enumakvawsgcpldapdescriptionstring | nullA description of the credentials
expiresstring | nullThe expiration date of these credentials
-
400 Bad Request
application/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 Credentialsdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/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 account does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or account 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/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 existsdetailstring | nullA 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 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/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