Skip to main content

Subject attributes

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

Example JSON: Subject attributes

{
  ...
  "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: Subject attributes

Name

Type

Req/Opt

Description

subject

object

required

Subject attributes details

.. attributes

array of objects

required

List of attributes to include in the certificate

.. .. type

string

required

Type of attributes to include in the certificate.

Possible values:

  • common_name

  • organization_name

  • organization_unit

  • street_address

  • postal_code

  • locality

  • state

  • country

  • email

  • unstructured_name

  • unstructured_address

  • serial_number

  • unique_description

  • domain_component

.. .. include

string

optional

Define if the subject attribute value is required or optional.

Possible values:

  • yes (default)

  • optional

.. .. encoding

string

optional

Define encoding standard for subject attribute values.

Possible values:

  • auto (default)

  • utf8_string

  • printable_string

  • ia5_string

.. .. allowed_source

array of strings

required

Define the allowed source of the subject attribute value.

Possible values:

  • csr: Sourced from CSR.

  • user_supplied: Provided in the certificate request. It only applies to the API, Portal, and Batch enrollment methods.

  • fixed_value (default): defined in the certificate profile. The fixed value is used when no csr or user_supplied value is provided.

In this section: