Devices - Get Attestation

Service:

IoT Central

API Version:

2022-07-31

Gerätenachweis abrufen

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}/attestation?api-version=2022-07-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
baseDomain	path	True	string	Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.
deviceId	path	True	string	Eindeutige ID des Geräts.
subdomain	path	True	string	Die Anwendungsunterdomäne.
api-version	query	True	string	Die Version der aufgerufenen API.

Antworten

Name	Typ	Beschreibung
200 OK	Attestation: SymmetricKeyAttestation TpmAttestation X509Attestation	Erfolg
Other Status Codes	Error	Eine Vom IoT Central Service empfangene Fehlerantwort. Headers x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get device attestation

Sample Request

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat/attestation?api-version=2022-07-31

Sample Response

Status code:

200

{
  "type": "x509",
  "x509": {
    "clientCertificates": {
      "primary": {
        "info": {
          "sha1Thumbprint": "<thumbprint>"
        }
      }
    }
  }
}

Definitionen

Name	Beschreibung
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.
SymmetricKey	Die symmetrische Schlüsseldefinition.
SymmetricKeyAttestation	Die Definition des symmetrischen Schlüsselnachweiss.
Tpm	Die Moduldefinition für vertrauenswürdige Plattformen.
TpmAttestation	Die TPM-Nachweisdefinition.
X509	Die X509-Definition.
X509Attestation	Die X509-Nachweisdefinition.
X509Certificate	Die X509-Zertifikatdefinition.
X509CertificateInfo	Die X509-Zertifikatinformationen.
X509Certificates	Die Definition von X509-Zertifikaten.

Error

Die Antwortfehlerdefinition.

Name	Typ	Beschreibung
error	ErrorDetails	Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldungsdetails.
requestId	string	Korrelations-ID für die aktuelle Anforderung.
time	string	Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.

SymmetricKey

Die symmetrische Schlüsseldefinition.

Name	Typ	Beschreibung
primaryKey	string	Der Primärschlüssel für diese Anmeldeinformationen.
secondaryKey	string	Der sekundäre Schlüssel für diese Anmeldeinformationen.

SymmetricKeyAttestation

Die Definition des symmetrischen Schlüsselnachweiss.

Name	Typ	Beschreibung
symmetricKey	SymmetricKey	Die Anmeldeinformationen für den symmetrischen Schlüssel für diesen Nachweis.
type	string: symmetricKey	Typ des Nachweises.

Tpm

Die Moduldefinition für vertrauenswürdige Plattformen.

Name	Typ	Beschreibung
endorsementKey	string	Der TPM-Unterstützungsschlüssel für diese Anmeldeinformationen.

TpmAttestation

Die TPM-Nachweisdefinition.

Name	Typ	Beschreibung
tpm	Tpm	Die TPM-Anmeldeinformationen für diesen Nachweis.
type	string: tpm	Typ des Nachweises.

X509

Die X509-Definition.

Name	Typ	Beschreibung
clientCertificates	X509Certificates	Die X.509-Clientzertifikate für diese Anmeldeinformationen.

X509Attestation

Die X509-Nachweisdefinition.

Name	Typ	Beschreibung
type	string: x509	Typ des Nachweises.
x509	X509	Die X.509-Anmeldeinformationen für diesen Nachweis.

X509Certificate

Die X509-Zertifikatdefinition.

Name	Typ	Beschreibung
certificate	string	Die Zeichenfolgendarstellung dieses Zertifikats.
info	X509CertificateInfo	Informationen zu diesem Zertifikat.

X509CertificateInfo

Die X509-Zertifikatinformationen.

Name	Typ	Beschreibung
sha1Thumbprint	string	Der SHA-1-Hashwert des Zertifikats.

X509Certificates

Die Definition von X509-Zertifikaten.

Name	Typ	Beschreibung
primary	X509Certificate	Das primäre X.509-Zertifikat für diese Anmeldeinformationen.
secondary	X509Certificate	Das sekundäre X.509-Zertifikat für diese Anmeldeinformationen.