HardwareOathTokenAuthenticationMethodDevice erstellen

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues hardwareOathTokenAuthenticationMethodDevice-Objekt . Diese API unterstützt zwei Szenarien:

  • Erstellen des neuen Hardwaretokens, ohne es einem Benutzer zuzuweisen. Anschließend können Sie die Zuweisung einem Benutzer vornehmen.
  • Erstellen Sie ein Hardwaretoken, und weisen Sie es einem Benutzer in derselben Anforderung zu.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Policy.ReadWrite.AuthenticationMethod Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung Policy.ReadWrite.AuthenticationMethod Nicht verfügbar.

Wichtig

Wenn Sie delegierte Berechtigungen mit Geschäfts-, Schul- oder Unikonten verwenden, muss der angemeldete Benutzer über eine entsprechende Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle mit den erforderlichen Berechtigungen verfügen. Die am wenigsten privilegierte integrierte Rolle, die für diesen Vorgang erforderlich ist, ist der Authentifizierungsrichtlinienadministrator.

Um einem Benutzer in einer einzelnen Anforderung ein Hardware-OATH-Token zu erstellen und zuzuweisen, muss der angemeldete Benutzer außerdem über Folgendes verfügen:

  • Die delegierte Berechtigung UserAuthenticationMethod.ReadWrite.All .
  • Entweder die Rolle "Authentifizierungsadministrator " (Rolle mit den geringsten Berechtigungen für die Zuweisung von Hardwaretoken an Benutzer, die keine Administratoren sind) oder die Rolle "Administrator mit den geringsten Berechtigungen" (Rolle mit den geringsten Berechtigungen für die Zuweisung von Hardwaretoken an Administratoren).

HTTP-Anforderung

POST /directory/authenticationMethodDevices/hardwareOathDevices

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des hardwareOathTokenAuthenticationMethodDevice-Objekts an.

Sie können die folgenden Eigenschaften festlegen, wenn Sie ein hardwareOathTokenAuthenticationMethodDevice erstellen.

Eigenschaft Typ Beschreibung
serialNumber Zeichenfolge Die Seriennummer des jeweiligen Hardwaretokens, häufig auf der Rückseite des Geräts. Erforderlich.
Hersteller Zeichenfolge Herstellername des Hardwaretokens. Erforderlich.
model Zeichenfolge Modellname des Hardwaretokens. Erforderlich.
secretKey Zeichenfolge Geheimer Schlüssel des spezifischen Hardwaretokens, der vom Hersteller bereitgestellt wird. Erforderlich.
timeIntervalInSeconds Int32 Aktualisierungsintervall des sechsstelligen Prüfcodes in Sekunden. Die möglichen Werte sind: 30 oder 60. Erforderlich.
hashFunction hardwareOathTokenHashFunction Hashfunktion des Hardwaretokens. Die möglichen Werte sind: hmacsha1 oder hmacsha256. Der Standardwert ist: hmacsha1. Optional.
assignTo identity Benutzer-ID, wenn Sie das Token einem Benutzer direkt zuweisen möchten. Optional.
displayName Zeichenfolge Name, der dem Hardware OATH-Token zur Verfügung gestellt werden kann. Optional.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 201 Created Antwortcode und ein hardwareOathTokenAuthenticationMethodDevice-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Erstellen eines Tokens ohne Benutzerzuweisung

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/beta/directory/authenticationMethodDevices/hardwareOathDevices
Content-Type: application/json

{
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
  "timeIntervalInSeconds": 30,
  "hashFunction": "hmacsha1"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.hardwareOathTokenAuthenticationMethodDevice",
  "id": "9b037532-f999-1ed9-13fd-849ffb995e11",
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": null,
  "timeIntervalInSeconds": 30,
  "status": "available",
  "lastUsedDateTime": null,
  "assignedTo": null,
  "hashFunction": "hmacsha1"
}

Beispiel 2: Erstellen eines Tokens und Zuweisen zu einem Benutzer

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/beta/directory/authenticationMethodDevices/hardwareOathDevices
Content-Type: application/json

{
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
  "timeIntervalInSeconds": 30,
  "hashFunction": "hmacsha1",
  "assignTo": {
    "id": "0cadbf92-####-####-####-############"
    }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.hardwareOathTokenAuthenticationMethodDevice",
  "id": "9b037532-f999-1ed9-13fd-849ffb995e11",
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": null,
  "timeIntervalInSeconds": 30,
  "status": "assigned",
  "lastUsedDateTime": null,
  "assignedTo": null,
  "hashFunction": "hmacsha1",
  "assignedTo": {
    "id": "0cadbf92-####-####-####-############",
    "displayName": "Amy Masters"
    }
}