v1

latestOpenAPI 3.0.12026-07-177949123.5 KB

v1/certificate

Enrollment with client generated keys, using CSR subject.

Enroll for a certificate given a PEM encoded PKCS#10 CSR. Response Format is 'DER' (default when excluded) or 'PKCS7' in base64 encoded PEM format

post/v1/certificate/pkcs10enroll

Request body

certificate_requeststring

Certificate request

certificate_profile_namestring

Certificate profile name

end_entity_profile_namestring

End Entity profile name

certificate_authority_namestring

Certificate Authority (CA) name

usernamestring

Username

passwordstring

Password

account_binding_idstring

Account Binding ID

include_chainboolean

emailstring

response_formatstring

Response Format (DER format is default)

subject_dnstring

Overwrite Subject Distinguished Name

start_timestring

Valid start time

end_timestring

Valid end time

Example request

{
  "certificate_request": "MIICh...V8shQ== OR -----BEGIN CERTIFICATE REQUEST-----\nMIICh...V8shQ==\n-----END CERTIFICATE REQUEST-----",
  "certificate_profile_name": "ENDUSER",
  "end_entity_profile_name": "ExampleEEP",
  "certificate_authority_name": "ExampleCA",
  "username": "JohnDoe",
  "password": "foo123",
  "account_binding_id": "1234567890",
  "email": "john.doe@example.com",
  "response_format": "DER",
  "subject_dn": "CN=John Doe,SURNAME=Doe,GIVENNAME=John,C=SE",
  "extension_data": [
    {
      "name": "1.3.6.1.5.5.7.1.24/customdata_STARTTIME",
      "value": "3003020105/2022-12-13 00:00:00"
    }
  ],
  "custom_data": [
    {
      "name": "1.3.6.1.5.5.7.1.24/customdata_STARTTIME",
      "value": "3003020105/2022-12-13 00:00:00"
    }
  ],
  "start_time": "ISO 8601 Date string, eg. '2023-06-15 14:07:09'",
  "end_time": "ISO 8601 Date string, eg. '2023-06-15 14:07:09'"
}

Response

Successful operation

certificatestring byte

Certificate

serial_numberstring

Hex Serial Number

response_formatstring

Response format

certificate_chainstring[]

CA Certificate chain

Example response

{
  "certificate": "TUlJRFh6Q0NBLi4uZVcxWnJvMD0=",
  "serial_number": "1234567890ABCDEF",
  "response_format": "DER",
  "certificate_chain": [
    "MII123efg...345xyz0="
  ]
}