Individual Enrollment - Get Attestation Mechanism

Get the attestation mechanism in the device enrollment record.

POST https://your-dps.azure-devices-provisioning.net/enrollments/{id}/attestationmechanism?api-version=2021-10-01

URI Parameters

Name In Required Type Description
id
path True

string

This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.

api-version
query True

string

The API version to use for the request. Supported versions include: 2021-10-01

Responses

Name Type Description
200 OK

AttestationMechanism

Success

Other Status Codes

ProvisioningServiceErrorDetails

Error response

Headers

x-ms-error-code: string

Definitions

Name Description
AttestationMechanism

Attestation mechanism for individualEnrollment as well as enrollmentGroup.

ProvisioningServiceErrorDetails

Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.

SymmetricKeyAttestation

Attestation via SymmetricKey.

TpmAttestation

Attestation via TPM.

X509Attestation

Attestation via X509.

X509CAReferences

Primary and secondary CA references.

X509CertificateInfo

X509 certificate info.

X509Certificates

Primary and secondary certificates

X509CertificateWithInfo

Certificate and Certificate info

AttestationMechanism

Attestation mechanism for individualEnrollment as well as enrollmentGroup.

Name Type Description
symmetricKey

SymmetricKeyAttestation

Attestation via SymmetricKey.

tpm

TpmAttestation

Attestation via TPM.

type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Attestation Type.

x509

X509Attestation

Attestation via X509.

ProvisioningServiceErrorDetails

Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.

Name Type Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

SymmetricKeyAttestation

Attestation via SymmetricKey.

Name Type Description
primaryKey

string

Primary symmetric key.

secondaryKey

string

Secondary symmetric key.

TpmAttestation

Attestation via TPM.

Name Type Description
endorsementKey

string

storageRootKey

string

X509Attestation

Attestation via X509.

Name Type Description
caReferences

X509CAReferences

Primary and secondary CA references.

clientCertificates

X509Certificates

Primary and secondary certificates

signingCertificates

X509Certificates

Primary and secondary certificates

X509CAReferences

Primary and secondary CA references.

Name Type Description
primary

string

secondary

string

X509CertificateInfo

X509 certificate info.

Name Type Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

Primary and secondary certificates

Name Type Description
primary

X509CertificateWithInfo

Certificate and Certificate info

secondary

X509CertificateWithInfo

Certificate and Certificate info

X509CertificateWithInfo

Certificate and Certificate info

Name Type Description
certificate

string

info

X509CertificateInfo

X509 certificate info.