Skip to main content

Subject attributes

Subject attributes define the subject attributes that can be included in the certificate.

JSON structure example

"subject": {
  "attributes": [
    {
      "type": "common_name",
      "encoding": "auto",
      "allowed_source": [
        "csr",
        "fixed_value",
        "user_supplied"
      ]
    },
    {
      "type": "organization_name",
      "include": "optional",
      "encoding": "auto",
      "allowed_source": [
        "csr",
        "fixed_value",
        "user_supplied"
      ]
    },
    {
      "type": "organization_unit",
      "include": "optional",
      "encoding": "auto",
      "allowed_source": [
        "csr",
        "fixed_value",
        "user_supplied"
      ]
    }
  ]
}

Parameters

Tableau 1. Parameters: Subject attributes

Name

Type

Required/optional

Possible values

subject

object

Required

Defines the subject distinguished name (DN) attributes that can be included in the issued certificate

.. attributes

Array of objects

Required

Specifies the subject attributes that can be included in the certificate subject DN

.. .. type

String

Required

Specifies the subject attribute type. Supported values include:

  • common_name

  • country

  • description

  • domain_component

  • email

  • locality

  • organization_name

  • organization_unit

  • postal_code

  • serial_number

  • state

  • street_address

  • unique_identifier

  • unstructured_address

  • unstructured_name

  • dn_qualifier

  • title

  • given_name

  • surname

  • product_identifier

  • vendor_identifier

  • pseudonym

  • organization_identifier

  • user_identifier

.. .. include

String

Optional

Specifies whether the attribute is required or optional in the certificate subject. Supported values:

  • yes (default)

  • optional

.. .. encoding

String

Optional

Specifies the encoding used for the subject attribute value. Supported values:

  • auto (default)

  • utf8_string

  • printable_string

  • ia5_string

.. .. allowed_sorce

Array of strings

Required

Specifies the allowed sources for the subject attribute value. Supported values:

  • csr: Uses the attribute value provided in the certificate signing request (CSR)

  • user_supplied: Allows the attribute value to be provided in the enrollment request. Supported only for API, Portal, and Batch enrollment methods

  • fixed_value: Uses a predefined value configured in the certificate template. This value is used only when no value is provided in the CSR or enrollment request