Enrollment profile specification

GET
https://one.digicert.com/iot/api/v1/enrollment-profile/{{enrollment_profile_id}}/enrollment-specification

Use this endpoint to get information about the fields used during enrollment for a specific enrollment profile.

This endpoint is only supported for enrollment profiles that use the API or PORTAL enrollment methods.

Example requests and responses

cURL
curl --request GET 'https://one.digicert.com/iot/api/v1/enrollment-profile/{{enrollment_profile_id}}/enrollment-specification' \
--header 'x-api-key: {{api_key}}' \
200 OK
{
    "fields": [
        {
            "id": "csr",
            "name": "csr",
            "type": "CERTIFICATE",
            "mandatory": true,
            "editable": true,
            "update_from_csr": false,
            "value_type": {
                "type": "string",
                "options": false,
                "multiple": false
            }
        },
        {
            "id": "signature_algorithm",
            "name": "signature_algorithm",
            "type": "CERTIFICATE",
            "mandatory": true,
            "editable": false,
            "update_from_csr": false,
            "value_type": {
                "type": "string",
                "options": true,
                "multiple": false
            },
            "default_value": "match_issuer",
            "options": [
                "sha1WithRSA",
                "sha256WithRSA",
                "sha384WithRSA",
                "sha512WithRSA",
                "match_issuer"
            ]
        },
        {
            "id": "subject.common_name",
            "name": "subject_common_name",
            "type": "CERTIFICATE",
            "mandatory": true,
            "editable": true,
            "update_from_csr": true,
            "value_type": {
                "type": "string",
                "options": false,
                "multiple": false
            }
        },
        {
            "id": "subject.organization_name",
            "name": "subject_organization",
            "type": "CERTIFICATE",
            "mandatory": false,
            "editable": false,
            "update_from_csr": false,
            "value_type": {
                "type": "string",
                "options": false,
                "multiple": false
            },
            "default_value": "Org Name"
        },
        {
            "id": "subject.organization_unit",
            "name": "subject_organization_unit",
            "type": "CERTIFICATE",
            "mandatory": false,
            "editable": true,
            "update_from_csr": false,
            "value_type": {
                "type": "string",
                "options": false,
                "multiple": true
            },
            "default_value": [
                "Org Unit 1",
                "Org Unit 2"
            ]
        },
        {
            "id": "subject.country",
            "name": "subject_country",
            "type": "CERTIFICATE",
            "mandatory": true,
            "editable": false,
            "update_from_csr": true,
            "value_type": {
                "type": "string",
                "options": false,
                "multiple": false
            }
        },
        {
            "id": "subject.state",
            "name": "subject_state",
            "type": "CERTIFICATE",
            "mandatory": false,
            "editable": false,
            "update_from_csr": true,
            "value_type": {
                "type": "string",
                "options": false,
                "multiple": false
            }
        },
        {...},
        {...},
        {...},
        {...},
        {...},
        {...},
        {...},
        {...}
    ]
}

Path parameters

Name Req/Opt Description
enrollment_profile_id required ID of the enrollment profile.

Response parameters

Name Type Description
fields array List of objects with details about the fields used for this enrollment profile.
.. id string ID of the field.
Use this ID to specify a value for the field during certificate enrollment.
.. name string Display name for the field.
.. type string Field type (CERTIFICATE or USER).
  • CERTIFICATE — Submit the value for this field in the certificate_profile_attributes section of your enrollment request.
  • USER — Submit the value for this field in the device_attributes section of your enrollment request.
.. mandatory boolean Whether the field is required.
If true and the field does not have a default_value, you must provide a value for this field when you submit an enrollment request.
.. editable boolean Whether users can provide a custom value for the field during enrollment.
If false, the value is extracted from the certificate signing request (CSR) or from enrollment source mapping. Alternatively, the default_value is used.
.. update_from_csr boolean Whether the value for this field is extracted from the CSR during enrollment.
.. value_type object Object that describes the type of values the field accepts.
.. .. type string Type of data the field accepts.
Possible values: string or number.
.. .. options boolean Whether the allowed values for this field are limited to a list of options (returned in the options array).
.. .. multiple boolean Describes whether a user can provide more than one value for the field.
If true, you can submit an array of values for this field during enrollment. Otherwise, you must submit a single value.
.. options array A list of the allowed values for this field.
Only returned when value_type.options is true.
.. default_value conditional The default value for the field.
The type for this value depends on the value_type details. It may be a single string, a single number, or an array.