Get authentication certificate details

GET

https://one.digicert.com/iot/api/v1/enrollment-profile/{{enrollment_profile_id}}/authentication-certificate/{{authentication_certificate_id}}

Use this endpoint to get information about an authentication certificate.

Example requests and responses

cURL

curl -X GET 'https://one.digicert.com/iot/api/v1/enrollment-profile/IOT_c1ac3d12-c2cb-46f0-808e-d0110c280c77/authentication-certificate/a876d305-713c-4f0e-93c1-855a518f885e' \
-H 'x-api-key: {{api_key}}' \
-H 'content-type: application/json;charset=UTF-8'

200 Success

{
    "id": "a876d305-713c-4f0e-93c1-855a518f885e",
    "certificate": {
        "id": "0dd83c6a-63c2-4d52-acc9-7140e0fb0332",
        "name": "AuthCert-001"
    },
    "enrollment_profile": {
        "id": "IOT_c1ac3d12-c2cb-46f0-808e-d0110c280c77",
        "name": "EST"
    },    
    "start_date": "2020-01-01",
    "end_date": "2021-01-01",
    "usage_limit": 100,
    "registered_values": [
        {
            "certificate_field": "subject.common_name",
            "matcher": "equals",
            "value": "common name registered value",
            "multiple": false
        },
        {
            "certificate_field": "subject.organization_unit",
            "matcher": "equals",
            "value": [
                "Unit 1",
                "Unit 2"
            ],
            "multiple": true
        }
    ],
    "number_of_usage": 0,
    "status": "ACTIVE",
    "created_at": "2020-09-29T12:05:37.519512Z",
    "pem": {{auth-cert_pem}},
    "certificate_expires_on": "2021-03-03T10:19:17Z",
    "certificate_serial_number": "57db86ca2713c7060aa43971ef32f598c1521c56",
    "certificate_issuer_common_name": "IoT Predemo Company Issuing CA",
    "certificate_thumbprint": "f99a9e95b9b7c40b985b36ea7a444801ed177ad5bd9aa4464f53694df2b98143",
    "certificate_organization": "DigiCert",
    "certificate_organization_units": []
}

400 Invalid enrollment profile ID

{
    "errors": [
        {
            "code": "invalid_input",
            "message": "Enrollment profile with id {{invalid}} does not exist"
        }
    ]
}

Path parameters

Name	Description
enrollment_profile_id	ID of the enrollment profile.
authentication_certificate_id	ID of the authentication certificate

Response parameters

Name	Type	Description
id	string	Authentication certificate ID.
certificate	object	Object with information about the certificate.
.. id	string	Certificate ID.
.. name	string	Certificate common name.
enrollment_profile	object	Object with enrollment profile details.
.. id	string	Enrollment profile ID.
.. name	string	Enrollment profile name.
number_of_usage	int	Number of times the authentication certificate has been used.
usage_limit	int	Number of times the authentication certificate can be used for enrollment.
start_date	string	Start date for the period of time during which the enrollment profile can use the authentication certificate. Format: `YYYY-MM-DD`
end_date	string	End date for the period of time during which the enrollment profile can use the authentication certificate. Format: `YYYY-MM-DD`
status	string	Authentication certificate status. Possible values: `ACTIVE`, `DISABLED`, or `DELETED`. Newly assigned authentication certificates are expected to have a status of `ACTIVE`.
created_at	string	Date and time (UTC) the authentication certificate was assigned.
pem	object	Certificate body, in PEM format.
certificate_expires_on	string	Date and time the certificate expires.
certificate_serial_number	string	Certificate serial number.
certificate_issuer_common_name	string	Common name of the certificate issuer.
certificate_thumbprint	string	Thumbprint of the certificate.
certificate_organization	string	Organization associated with the certificate.
certificate_organization_units	array	List of organization units associated with the certificate.
registered_values	object	List of objects with details about the certificate fields that are validated when using this authentication certificate. Only returned for authentication certificates with `registered_values.`
.. certificate_field	string	Name of a certificate field that is validated when using this passcode. Possible values: See Certificate fields that support registered values.
.. matcher	string	Operator used when comparing the value of the certificate field to the registered values. Possible values: `equals`
.. value	string/array	The value or list of values that are compared with the value of the chosen `certificate_field`.
.. multiple	bool	Returns `true` when the data type of the certificate field is an array. Otherwise, `false`.

Certificate fields that support registered values

Field	Type
subject.common_name	string
subject.organization_name	string
subject.organization_unit	array
subject.country	string
subject.state	string
subject.locality	string
subject.street_address	array
subject.postal_code	string
subject.email	string
challenge_password	string

Example requests and responses

Path parameters

Response parameters

Certificate fields that support registered values

Informazioni