Sign in

v1

latestOpenAPI 3.0.12026-07-177949123.5 KB
v1/ssh

Enrollment with public key

Enroll for a ssh certificate.

post/v1/ssh/certificaterequest

Request body

end_entity_profilestring

End Entity profile name

certificate_profilestring

Certificate profile name

certificate_authoritystring

Certificate Authority (CA) name

key_idstring

SSH Key Identifier

commentstring

Comment

public_keystring

Public Key

principalsstring[]

Valid principals

additional_extensionsobject
usernamestring

Username

passwordstring

Password

not_beforestring

Valid notBefore date

not_afterstring

Valid notAfter date

Example request

{
  "end_entity_profile": "ExampleEEP",
  "certificate_profile": "ENDUSER",
  "certificate_authority": "ExampleCA",
  "key_id": "ski-02",
  "comment": "Yellow fish under blue water",
  "public_key": "ssh-rsa AAA...EWj",
  "principals": [
    "Wishman",
    "Bradman"
  ],
  "critical_options": {
    "forceCommand": "./init.sh",
    "sourceAddress": "1.2.3.0/24,1.10.10.1/32"
  },
  "username": "JohnDoe",
  "password": "foo123",
  "not_before": "ISO 8601 Date string, eg. '2023-06-15T14:07:09Z'",
  "not_after": "ISO 8601 Date string, eg. '2024-06-15T14:07:09Z'"
}

Response

Successful response

certificatestring byte

Certificate

response_formatstring

Response format

Example response

{
  "certificate": "YzNOLi4uVDA5",
  "response_format": "BYTE"
}