Register a new account
Register a new account
Account to register
|
id
string (Internal ID)
requiredObject internal ID |
||
|
type
string
requiredThe type of the account
Value
local
|
||
|
identifier
string | null
The account's identifier |
||
|
description
string | null
The account's description |
||
|
permissions
array of objects | null (Permission)
List of the principal's permissions |
||
|
Array [
] |
||
|
roles
array of string | null
List of the principal's roles |
||
|
expires
string | null
The account's expiration date |
||
|
creationDate
string | null
The account's creation date |
||
|
lastAuthentication
string | null
The account's last authentication time |
||
|
lastModification
string | null
The account's last modification time |
||
|
id
string (Internal ID)
requiredObject internal ID |
||
|
type
string
requiredThe type of the account
Value
x509
|
||
|
identifier
string | null
The identifier for the account. It must be a Distinguished Name |
||
|
description
string | null
The account's description |
||
|
permissions
array of objects | null (Permission)
List of the principal's permissions |
||
|
Array [
] |
||
|
roles
array of string | null
List of the principal's roles |
||
|
creationDate
string | null
The account's creation date |
||
|
lastAuthentication
string | null
The account's last authentication time |
||
|
lastModification
string | null
The account's last modification time |
||
-
201 Account successfully registered
application/jsonidstring (Internal ID) requiredObject internal ID
typestring requiredThe type of the account
Valuelocalidentifierstring | nullThe account's identifier
secretstring | nullThe clear password of the account
descriptionstring | nullThe account's description
permissionsarray of objects | null (Permission)List of the principal's permissions
Array [
valuestring requiredA permission string that give rights on specific operations
]
rolesarray of string | nullList of the principal's roles
expiresstring | nullThe account's expiration date
creationDatestring | nullThe account's creation date
lastAuthenticationstring | nullThe account's last authentication time
lastModificationstring | nullThe account's last modification time
idstring (Internal ID) requiredObject internal ID
typestring requiredThe type of the account
Valuex509identifierstring | nullThe identifier for the account. It must be a Distinguished Name
descriptionstring | nullThe account's description
permissionsarray of objects | null (Permission)List of the principal's permissions
Array [
valuestring requiredA permission string that give rights on specific operations
]
rolesarray of string | nullList of the principal's roles
creationDatestring | nullThe account's creation date
lastAuthenticationstring | nullThe account's last authentication time
lastModificationstring | nullThe account's last modification time
-
400 Bad Request
application/jsonerrorstring requiredThe error code of the problem
ValueACCOUNT-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Accounttitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Accountdetailstring | 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
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
ValueACCOUNT-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