Update an existing OpenSSH Certificate Authority

Update an existing Certificate Authority

Body required

application/json

OpenSSH Certificate Authority to update

enroll

boolean required

If true, this Certificate Authority can sign publicKey

enforceKeyUnicity

boolean required

If true, each enrollment request must have a unique key

krlPolicy

object | null (KRL Generation Policy) required

Define how to generate the KRL fot his OpenSSH Certificate Authority

validity

string required

The duration of the KRL's validity

hardGeneration

string | null

The KRL will be generated at each period

lazyGeneration

string | null

The KRL will be checked at each period and generated if a new entry was added

name

string required

This signer's name

privateKey

object (Signer Private Key) required

This signer's private key

keystore

string required

The Keystore in which the key is stored

name

string required

The name of the key in the keystore

hashAlgorithm

string | null (Hash Algorithm)

The Hash Algorithm to use when signing with this key

Enum SHA1 SHA224 SHA256 SHA384 SHA512 SHA3_224 SHA3_256 SHA3_384 SHA3_512

usePSS

boolean | null

For RSA Keys in PKCS11 Keystores only: use the PSS signature algorithm

overridePermissions

object | null (OpenSSH Certificate Authority Override Permissions)

type

boolean | null

Can the openssh certificate type be overridden

backdate

boolean | null

Can the backdate be overridden

lifetime

boolean | null

Can the lifetime be overridden

triggers

object | null (TriggersCertificateAuthority)

Triggers that apply on events on this OpenSSH Certificate Authority (CA)

onKRLGeneration

array of string | null

Name of the triggers to execute when this CA's KRL are generated (manually or via cron)

onKRLGenerationError

array of string | null

Name of the triggers to execute when an error occurs when this CA's KRL are generated (manually or via cron)

onKRLGenerationRecover

array of string | null

Name of the triggers to execute when this CA's KRL are successfully generated when the last status was error

onKRLSync

array of string | null

Name of the triggers to execute when this CA's KRL are synced

onKRLExpiration

array of string | null

Name of the triggers to execute when this CA's KRL expire

queue

string | null

The name of the queue to apply on this signer's operations

Responses

200 OpenSSH Certificate Authority successfully updated

string (Internal ID) required

Object internal ID

enroll

boolean required

If true, this Certificate Authority can sign publicKey

enforceKeyUnicity

boolean required

If true, each enrollment request must have a unique key

krlPolicy

object | null (KRL Generation Policy) required

Define how to generate the KRL fot his OpenSSH Certificate Authority

validity

string required

The duration of the KRL's validity

hardGeneration

string | null

The KRL will be generated at each period

lazyGeneration

string | null

The KRL will be checked at each period and generated if a new entry was added

publicKey

string required

The public key of the SSHSigner

name

string required

This signer's name

privateKey

object (Signer Private Key) required

This signer's private key

keystore

string required

The Keystore in which the key is stored

name

string required

The name of the key in the keystore

hashAlgorithm

string | null (Hash Algorithm)

The Hash Algorithm to use when signing with this key

Enum SHA1 SHA224 SHA256 SHA384 SHA512 SHA3_224 SHA3_256 SHA3_384 SHA3_512

usePSS

boolean | null

For RSA Keys in PKCS11 Keystores only: use the PSS signature algorithm

overridePermissions

object | null (OpenSSH Certificate Authority Override Permissions)

type

boolean | null

Can the openssh certificate type be overridden

backdate

boolean | null

Can the backdate be overridden

lifetime

boolean | null

Can the lifetime be overridden

triggers

object | null (TriggersCertificateAuthority)

Triggers that apply on events on this OpenSSH Certificate Authority (CA)

onKRLGeneration

array of string | null

Name of the triggers to execute when this CA's KRL are generated (manually or via cron)

onKRLGenerationError

array of string | null

Name of the triggers to execute when an error occurs when this CA's KRL are generated (manually or via cron)

onKRLGenerationRecover

array of string | null

Name of the triggers to execute when this CA's KRL are successfully generated when the last status was error

onKRLSync

array of string | null

Name of the triggers to execute when this CA's KRL are synced

onKRLExpiration

array of string | null

Name of the triggers to execute when this CA's KRL expire

queue

string | null

The name of the queue to apply on this signer's operations

400 Bad Request

401 Unauthorized request

403 Forbidden action

404 Not Found

500 Internal Server error

put

/api/v1/ssh/cas

{

"enroll": true ,

"enforceKeyUnicity": true ,

"overridePermissions":

{ ... } ,

"krlPolicy":

{ ... } ,

"triggers":

{ ... } ,

"name": "signer" ,

"privateKey":

{ ... } ,

"queue": "Slow-queue"

}