Register a new keystore
Register a new keystore
Keystore to register
|
id
string (Internal ID)
requiredObject internal ID |
|
type
string
requiredThe Keystore's type
Value
akv
|
|
name
string
requiredThe Keystore's name |
|
vaultUrl
string
requiredThe Keystore's url |
|
description
string | null
The Keystore's description |
|
proxy
string | null
The proxy to access the Keystore |
|
timeout
string | null
The timeout to join the Keystore |
|
tenant
string | null
The Azure Keystore's tenant |
|
credentials
string | null
The Keystore's credentials |
|
id
string (Internal ID)
requiredObject internal ID |
|
type
string
requiredThe Keystore's type
Value
aws
|
|
name
string
requiredThe Keystore's name |
|
description
string | null
The Keystore's description |
|
proxy
string | null
The proxy to access the Keystore |
|
timeout
string | null
The timeout to join the Keystore |
|
endpoint
string | null
The Keystore's endpoint if not the default Amazon endpoint |
|
credentials
string | null
The Keystore's credentials |
|
region
string | null
The Keystore's AWS Region |
|
roleArn
string | null
The Keystore's Role ARN |
|
id
string (Internal ID)
requiredObject internal ID |
|
type
string
requiredThe Keystore's type
Value
gcp
|
|
name
string
requiredThe Keystore's name |
|
project
string
requiredThe GCP Project Name |
|
location
string
requiredThe GCP Location to use |
|
keyRing
string
requiredThe GCP Key Ring to use |
|
description
string | null
The Keystore's description |
|
proxy
string | null
The proxy to access the Keystore |
|
timeout
string | null
The timeout to join the Keystore |
|
credentials
string | null
The Keystore's credentials |
|
id
string (Internal ID)
requiredObject internal ID |
||
|
type
string
requiredThe Keystore's type
Value
pkcs11
|
||
|
name
string
requiredThe Keystore's name |
||
|
library
string
requiredThe Path to the PKCS11 Library to use for the Keystore |
||
|
slot
integer
requiredThe PKCS11 Keystore's Slot to use |
||
|
pin
object (Secret String)
required
A string containing a hidden secret |
||
|
||
|
rsaX931Mode
boolean
requiredUse the X931 Mode for RSA Key Generation |
||
|
description
string | null
The Keystore's description |
||
|
poolSize
integer | null
Number of parallel sessions on the PKCS11 Keystore (by Stream node) |
||
|
id
string (Internal ID)
requiredObject internal ID |
|
type
string
requiredThe Keystore's type
Value
software
|
|
name
string
requiredThe Keystore's name |
|
description
string | null
The Keystore's description |
-
201 Keystore successfully registered
application/jsonidstring (Internal ID) requiredObject internal ID
typestring requiredThe Keystore's type
Valueakvnamestring requiredThe Keystore's name
vaultUrlstring requiredThe Keystore's url
descriptionstring | nullThe Keystore's description
proxystring | nullThe proxy to access the Keystore
timeoutstring | nullThe timeout to join the Keystore
tenantstring | nullThe Azure Keystore's tenant
credentialsstring | nullThe Keystore's credentials
idstring (Internal ID) requiredObject internal ID
typestring requiredThe Keystore's type
Valueawsnamestring requiredThe Keystore's name
descriptionstring | nullThe Keystore's description
proxystring | nullThe proxy to access the Keystore
timeoutstring | nullThe timeout to join the Keystore
endpointstring | nullThe Keystore's endpoint if not the default Amazon endpoint
credentialsstring | nullThe Keystore's credentials
regionstring | nullThe Keystore's AWS Region
roleArnstring | nullThe Keystore's Role ARN
idstring (Internal ID) requiredObject internal ID
typestring requiredThe Keystore's type
Valuegcpnamestring requiredThe Keystore's name
projectstring requiredThe GCP Project Name
locationstring requiredThe GCP Location to use
keyRingstring requiredThe GCP Key Ring to use
descriptionstring | nullThe Keystore's description
proxystring | nullThe proxy to access the Keystore
timeoutstring | nullThe timeout to join the Keystore
credentialsstring | nullThe Keystore's credentials
idstring (Internal ID) requiredObject internal ID
typestring requiredThe Keystore's type
Valuepkcs11namestring requiredThe Keystore's name
librarystring requiredThe Path to the PKCS11 Library to use for the Keystore
slotinteger requiredThe PKCS11 Keystore's Slot to use
pinobject (Secret String) requiredThe PKCS11 Keystore's pin code
clearstring | nullThe clear value of the secret
securestring | nullThe hidden value of the secret
rsaX931Modeboolean requiredUse the X931 Mode for RSA Key Generation
descriptionstring | nullThe Keystore's description
poolSizeinteger | nullNumber of parallel sessions on the PKCS11 Keystore (by Stream node)
idstring (Internal ID) requiredObject internal ID
typestring requiredThe Keystore's type
Valuesoftwarenamestring requiredThe Keystore's name
descriptionstring | nullThe Keystore's description
-
400 Bad Request
application/jsonerrorstring requiredThe error code of the problem
ValueKEYSTORE-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid keystoretitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid keystoredetailstring | 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
ValueKEYSTORE-004messagestring requiredA short, human-readable summary of the problem type
ValueKeystore already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueKeystore 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
ValueKEYSTORE-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