Skip to main content

Subject

Defines the fields that are included as the subject distinguished name in the certificate.

Example JSON

"subject":
{
	"attributes":
	[
		{
			"type":"common_name",
			"include":"yes"
		},
		{
			"type":"organization_name"
		},
		{
			"type":"organization_unit",
			"include":"optional".
                        "allowed_source":
                        [
                            "fixed_value",
                            "user_supplied"
                        ]
		},
		{
			"type":"country",
			"include":"optional"
		}
	]
}

Parameters

Name

Type

Req/Opt

Description

subject

object

required

Certificate subject details.

attributes

array of objects

required

Defines attributes allowed or required in the certificate.

type

string

required

Indicates type of subject DN field. Can be a predefined value or a custom OID:

  • common_name

  • organization_name

  • organization_unit

  • street_address

  • postal_code

  • locality

  • state

  • country

  • email

  • unstructured_name

  • unstructured_address

  • serial_number

  • unique_description

  • domain_component

  • dn_qualifier

  • title

  • given_name

  • surname

  • user_identifier

include

string

optional

Indicates if the subject attribute type must be included in the certificate. Possible values:

  • yes (default)

  • optional

encoding

string

optional

The type of ASN.1 encoding to use. Possible values:

  • auto (default)

    Note

    Values are encoded as printable_string unless that character set is not allowed, in which case utf8_string is applied. Other exceptions can also occur.

  • utf8_string

  • printable_string

  • ia5_string

allowed_source

array of strings

optional

Indicates the allowed source types for the values. Allowed sources can be one or more of these inputs:

  • organization (default) - The value can come from the pre-defined organization.

  • csr - The value can come from the CSR.

  • user_supplied - The value can be supplied by the end user.

  • fixed_value - The value can be set to a fixed value when creating a certificate profile.

  • custom_value - The value can be supplied from a custom values field.

  • issuer - The value is copied from the issuing CA.

In this section: