v1/endentity

Add new end entity, if it does not exist

Changed on Mar 11, 2025

post/v1/endentity

Request

Base URL
/ejbca/ejbca-rest-api (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/keyfactor/apis/ejbca-rest-interface/docs/v1/endentity/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

usernamestring

Username

passwordstring

Password

subject_dnstring

Subject Distinguished Name

subject_alt_namestring

Subject Alternative Name (SAN)

emailstring

ca_namestring

Certificate Authority (CA) name

certificate_profile_namestring

Certificate profile name

end_entity_profile_namestring

End Entity profile name

token'USERGENERATED, P12, JKS, PEM'

Token type property

account_binding_idstring

Account Binding ID

key_recoverableboolean

Key recoverable or not

status'NEW, FAILED, INITIALIZED, INPROCESS, GENERATED, REVOKED, HISTORICAL, KEYRECOVERY, WAITINGFORADDAPPROVAL'

End entity status property

send_notificationboolean

Send notification or not

start_timestring

Valid start time

end_timestring

Valid end time

certificate_serial_numberinteger

Certificate Serial Number

card_numberstring

Card Number

Example request

{
  "username": "JohnDoe",
  "password": "foo123",
  "subject_dn": "CN=John Doe,SURNAME=Doe,GIVENNAME=John,C=SE",
  "subject_alt_name": "rfc822Name=john.doe@example.com",
  "email": "john.doe@example.com",
  "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"
    }
  ],
  "ca_name": "ExampleCA",
  "certificate_profile_name": "ENDUSER",
  "end_entity_profile_name": "ExampleEEP",
  "token": "P12",
  "account_binding_id": "1234567890",
  "status": "NEW",
  "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'",
  "certificate_serial_number": 1234567890,
  "card_number": "1234567890"
}

Response

Successful operation

Changes

Mar 11, 20254045b1bab09f Revision changes
- breaking
  removed the enum value JKS of the request property
- breaking
  removed the enum value P12 of the request property
- breaking
  removed the enum value PEM of the request property
- breaking
  removed the enum value USERGENERATED of the request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new USERGENERATED P12 JKS PEM enum value to the request property
- info
  added the success response with the status
Mar 11, 202537878df36b77 Revision changes
- breaking
  removed the enum value USERGENERATED P12 JKS PEM of the request property
- breaking
  removed the success response with the status
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- info
  added the new JKS enum value to the request property
- info
  added the new P12 enum value to the request property
- info
  added the new PEM enum value to the request property
- info
  added the new USERGENERATED enum value to the request property

Operation history (4 revisions)