POST
/
api
/
v1
/
ssh
/
certificates
/
issue

Body

application/json
certificateTemplateId
string
required

The ID of the SSH certificate template to issue the SSH credentials with.

Minimum length: 1
principals
string[]
required

The list of principals (usernames, hostnames) to include in the certificate.

keyAlgorithm
enum<string>
default: RSA_2048

The type of public key algorithm and size, in bits, of the key pair for the SSH CA.

Available options:
RSA_2048,
RSA_4096,
EC_prime256v1,
EC_secp384r1
certType
enum<string>
default: user

The type of certificate to issue. This can be one of user or host.

Available options:
user,
host
ttl
string

The time to live for the certificate such as 1m, 1h, 1d, ... If not specified, the default TTL for the template will be used.

keyId
string

The key ID to include in the certificate. If not specified, a default key ID will be generated.

Maximum length: 50

Response

200 - application/json
serialNumber
string
required

The serial number of the issued SSH certificate.

signedKey
string
required

The SSH certificate or signed SSH public key.

privateKey
string
required

The private key corresponding to the issued SSH certificate.

publicKey
string
required

The public key of the issued SSH certificate.

keyAlgorithm
enum<string>
required

The type of public key algorithm and size, in bits, of the key pair for the SSH CA.

Available options:
RSA_2048,
RSA_4096,
EC_prime256v1,
EC_secp384r1

Was this page helpful?