Update an existing keystore
Update an existing keystore
The keystore to update
|
type
string (KeystoreType)
requiredThe Keystore's type
Value
akv
|
|
name
string
requiredThe Keystore's name |
|
vaultUrl
string
requiredThe Keystore's url |
|
description
string
The Keystore's description |
|
proxy
string
The proxy to access the Keystore |
|
timeout
string
The timeout to join the Keystore |
|
tenant
string
The Azure Keystore's tenant |
|
credentials
string
The Keystore's credentials |
|
type
string (KeystoreType)
requiredThe Keystore's type
Value
aws
|
|
name
string
requiredThe Keystore's name |
|
description
string
The Keystore's description |
|
proxy
string
The proxy to access the Keystore |
|
timeout
string
The timeout to join the Keystore |
|
endpoint
string
The Keystore's endpoint if not the default Amazon endpoint |
|
credentials
string
The Keystore's credentials |
|
region
string
The Keystore's AWS Region |
|
roleArn
string
The Keystore's Role ARN |
|
type
string (KeystoreType)
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
The Keystore's description |
|
proxy
string
The proxy to access the Keystore |
|
timeout
string
The timeout to join the Keystore |
|
credentials
string
The Keystore's credentials |
|
type
string (KeystoreType)
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 |
||
|
rsaX931Mode
boolean
requiredUse the X931 Mode for RSA Key Generation |
||
|
description
string
The Keystore's description |
||
|
pin
object (Secret String)
A string containing a hidden secret. Omit this field to keep the currently stored PIN unchanged. |
||
|
||
|
poolSize
integer
Number of parallel sessions on the PKCS11 Keystore (by Stream node) |
||
|
userType
integer
PKCS#11 user to open the session as |
||
|
type
string (KeystoreType)
requiredThe Keystore's type
Value
software
|
|
name
string
requiredThe Keystore's name |
|
description
string
The Keystore's description |
-
200 Keystore successfully updated
application/jsonidstring (Internal ID) requiredObject internal ID
typestring (KeystoreType) requiredThe Keystore's type
Valueakvnamestring requiredThe Keystore's name
vaultUrlstring requiredThe Keystore's url
statusobject (Keystore status report) requiredlastCheckstring requiredWhen this healthcheck last occurred
statusstring (Keystore Status) requiredDescribe the status of the keystore
EnumsuccessfailurerunningmessagestringError message in case of error
descriptionstringThe Keystore's description
proxystringThe proxy to access the Keystore
timeoutstringThe timeout to join the Keystore
tenantstringThe Azure Keystore's tenant
credentialsstringThe Keystore's credentials
idstring (Internal ID) requiredObject internal ID
typestring (KeystoreType) requiredThe Keystore's type
Valueawsnamestring requiredThe Keystore's name
statusobject (Keystore status report) requiredlastCheckstring requiredWhen this healthcheck last occurred
statusstring (Keystore Status) requiredDescribe the status of the keystore
EnumsuccessfailurerunningmessagestringError message in case of error
descriptionstringThe Keystore's description
proxystringThe proxy to access the Keystore
timeoutstringThe timeout to join the Keystore
endpointstringThe Keystore's endpoint if not the default Amazon endpoint
credentialsstringThe Keystore's credentials
regionstringThe Keystore's AWS Region
roleArnstringThe Keystore's Role ARN
idstring (Internal ID) requiredObject internal ID
typestring (KeystoreType) 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
statusobject (Keystore status report) requiredlastCheckstring requiredWhen this healthcheck last occurred
statusstring (Keystore Status) requiredDescribe the status of the keystore
EnumsuccessfailurerunningmessagestringError message in case of error
descriptionstringThe Keystore's description
proxystringThe proxy to access the Keystore
timeoutstringThe timeout to join the Keystore
credentialsstringThe Keystore's credentials
idstring (Internal ID) requiredObject internal ID
typestring (KeystoreType) 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
rsaX931Modeboolean requiredUse the X931 Mode for RSA Key Generation
userTypeinteger requiredPKCS#11 user to open the session as
statusobject (Keystore status report) requiredlastCheckstring requiredWhen this healthcheck last occurred
statusstring (Keystore Status) requiredDescribe the status of the keystore
EnumsuccessfailurerunningmessagestringError message in case of error
descriptionstringThe Keystore's description
poolSizeintegerNumber of parallel sessions on the PKCS11 Keystore (by Stream node)
idstring (Internal ID) requiredObject internal ID
typestring (KeystoreType) requiredThe Keystore's type
Valuesoftwarenamestring requiredThe Keystore's name
statusobject (Keystore status report) requiredlastCheckstring requiredWhen this healthcheck last occurred
statusstring (Keystore Status) requiredDescribe the status of the keystore
EnumsuccessfailurerunningmessagestringError message in case of error
descriptionstringThe Keystore's description
-
400 Bad Request
application/problem+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 keystoredetailstringA 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-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 trusteddetailstringA 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 expireddetailstringA 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 revokeddetailstringA 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
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-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 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
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
-
404 Not Found
application/problem+jsonerrorstring requiredThe error code of the problem
ValueKEYSTORE-003messagestring requiredA short, human-readable summary of the problem type
ValueKeystore not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueKeystore not founddetailstringA 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
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 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