CSV format for registering many devices

Batch device registration in DigiCert® Device Trust Manager allows you to register multiple devices and issue bootstrap certificates in a single job using a CSV file. This reference details the required CSV structure to ensure successful batch processing.

The CSV file used for registering many devices must include at least two rows:

Header row: Defines the fields for each device, including:
- device_name
- device_description
- Certificate attribute headers
- csr (if required by the certificate management policy)
Data rows: Contain the details for each device registration. Make sure each value in a data row matches the corresponding header to maintain alignment and proper processing.

CSV header details

Device name

Use the device_name column header to specify a name for each device. This name will appear under Device Management > Devices.

Device description

Use the device_description column header to provide a description for each device.

Certificate attributes

Include headers for the required certificate attributes based on your certificate profile configuration, such as:

Subject attributes, such as subject.common_name)
SAN (Subject Alternative Name) attributes
Extensions
Key usage and extended key usage attributes

Note

If a certificate attribute is specified in both the CSR and the CSV column, the value in the CSV column takes precedence and will be used in the request.

The following table outlines the header cell values, expected data cell value formats, and descriptions for each certificate attribute used in CSV files for batch certificate enrollment.

Table 1. Certificate attribute details

Header cell value	Data cell value	Description
subject.common_name	Single value	Subject DN common name.
subject.organization_name	Single value	Subject DN organization name.
subject.organization_unit	Single or multiple values	Subject DN organization units.
subject.country	Single value	Subject DN country.
subject.state	Single value	Subject DN state.
subject.locality	Single value	Subject DN locality.
subject.street_address	Single value	Subject DN address.
subject.postal_code	Single value	Subject DN postal code.
subject.unique_identifier	Single value	Subject DN unique identifier.
subject.email	Single value	Subject DN email.
subject.domain_component	Single or multiple values	Subject DN domain components.
san.critical	Yes or no	If yes, SAN is critical. Otherwise, no.
san.dns_name	Single value	SAN DNS names.
san.user_principal_name	Single or multiple values	SAN user principal names (UPN).
san.email	Single or multiple values	SAN emails.
san.other_name	SAN other name value, formatted as a JSON string	SAN other name. To learn how to format this value, visit Subject directory attributes (SDA).
san.other_name.hardware_module_name.type	Single OID value	SAN hardware module name type.
san.other_name.hardware_module_name.serial_number	Single HEX string value	SAN hardware module name serial number.
extensions.subject_directory	Subject directory attribute value, formatted as a JSON string	Subject directory attributes value. To learn how to format this value, visit Subject directory attributes (SDA).
key_usage.critical	Yes or no	If yes, key usage is critical. Otherwise, no.
key_usage.rsa_additional_values	Single or multiple values	Key usage values for RSA key.
key_usage.ecdsa_additional_values	Single or multiple values	Key usage values for EC key.
extended_key_usage.critical	Yes or no	If yes, extended key usage is critical. Otherwise, no.
extended_key_usage.additional_values	Single or multiple values	Extended key usage values.

CSR

If your certificate management policy requires a CSR for generating the device's x.509 bootstrap certificate, include it in the csr column.

CSRs must be in Base-64 encoded PEM format and include the -----BEGIN CERTIFICATE REQUEST----- and -----END CERTIFICATE REQUEST----- tags. Below is an example of a PEM-formatted CSR:

 -----BEGIN CERTIFICATE REQUEST-----
...CSR content...
-----END CERTIFICATE REQUEST-----

Device registration data rows

Each data row in the CSV represents an individual device registration, containing values for each field specified in the header row.

Note

There is no limit to the number of data rows, but the compressed ZIP file containing your CSV data must not exceed 200 MB.

"device_name","device_description","subject.common_name","csr""device001","device001 description","device001cn","-----BEGIN CERTIFICATE REQUEST-----...""device002","device002 description","device002cn","-----BEGIN CERTIFICATE REQUEST-----...""device003","device003 description","device003cn","-----BEGIN CERTIFICATE REQUEST-----..."

This example demonstrates a CSV with device_name, device_description, subject.common_name, and csr columns.