Sign in
certificate-authorities

get description of subject DN fields for CSR

<h3>List DN field descriptions to collect CSR parameters</h3>
get/certificate-authorities/{ca_name}/csr-subject-fields

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/certificate-authorities/{ca_name}/csr-subject-fields
  • Auth: API key in header Authorization

Path parameters

ca_namestring text required

common name of the CA

Query parameters

key_idstring text

id of the key. If provided, used only for validating correct key usage

key_usage_type'AUTHENTICATION' | 'SIGNING' enum required

intended usage for the key (signing or authentication)

Example:AUTHENTICATION

which usage type this CSR is for

member_idstring text

member client id for signing CSRs. <instance_id>:<member_class>:<member_code>

is_new_memberboolean

whether or not the member in the member_id parameter is a new member

Response

csr subject field objects

idstring text required

the identifier of the field (such as 'O', 'OU' etc)

labelstring text

label of the field, used to display the field in the user interface

label_keystring text

localization key for label of the field, used to display the field in the user interface

default_valuestring text

the default value of the field. Can be empty.

read_onlyboolean required

if this field is read-only

requiredboolean required

if this field is required to be filled

localizedboolean required

if true, label key is in property "label_key". If false, actual label is in property "label"

Example response

[
  {
    "id": "O",
    "label": "ORGANIZATION_NAME",
    "label_key": "Organization name (O)",
    "read_only": true,
    "required": true,
    "localized": true
  }
]

Changes

No recorded changes to this operation across all 50 revisions of this API.