1 つ以上の hardwareOathTokenAuthenticationMethodDevice オブジェクトを作成する

2025-07-03

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

1 つ以上の hardwareOathTokenAuthenticationMethodDevice オブジェクトを作成します。この API では、次の 2 つのシナリオがサポートされています。

ユーザーに割り当てずに新しいハードウェアトークンを作成します。その後、ユーザーに割り当てることができます。
同じ要求で個々のハードウェアトークンを作成してユーザーに割り当てます。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	Policy.ReadWrite.AuthenticationMethod	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Policy.ReadWrite.AuthenticationMethod	注意事項なし。

重要

職場または学校のアカウントで委任されたアクセス許可を使用する場合、サインインしているユーザーは、適切なMicrosoft Entraロールまたは必要なアクセス許可を持つカスタムロールを持っている必要があります。この操作に必要な最小限の特権の組み込みロールは 、認証ポリシー管理者です。

1 つの要求でハードウェア OATH トークンを作成してユーザーに割り当てるには、サインインしているユーザーにも次のものが必要です。

UserAuthenticationMethod.ReadWrite.All 委任されたアクセス許可。
認証管理者 (管理者以外のユーザーにハードウェアトークンを割り当てるための最小特権ロール) または特権認証管理者 (管理者ユーザーにハードウェアトークンを割り当てるための最小特権ロール) ロール。

HTTP 要求

PATCH /directory/authenticationMethodDevices/hardwareOathDevices

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。
Content-Type	application/json. 必須です。

要求本文

要求本文で、 hardwareOathTokenAuthenticationMethodDevice オブジェクトの JSON 表現を指定します。

hardwareOathTokenAuthenticationMethodDevice を作成するときに、次のプロパティを指定できます。

プロパティ	型	説明
シリアル番号	文字列	多くの場合、デバイスの背面にある特定のハードウェアトークンのシリアル番号。必須です。
manufacturer	文字列	ハードウェアトークンの製造元名。必須です。
model	文字列	ハードウェアトークンのモデル名。必須です。
secretKey	文字列	ベンダーによって提供される、特定のハードウェアトークンの秘密キー。必須です。
timeIntervalInSeconds	Int32	6 桁の検証コードの更新間隔 (秒単位)。使用可能な値は 30 または 60 です。必須です。
hashFunction	hardwareOathTokenHashFunction	ハードウェアトークンのハッシュ関数。使用可能な値: `hmacsha1`、`hmacsha256`。既定値は `hmacsha1` です。省略可能。
assignTo	identity	トークンをユーザーに直接割り当てる場合は、ユーザー ID。省略可能。

応答

成功した場合、このメソッドは応答コード 201 Created と、応答本文の hardwareOathTokenAuthenticationMethodDevice オブジェクトを返します。

例

要求

次の例は要求を示しています。

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

{
  "@context": "#$delta",
  "value": [
    {
      "@contentId": "1",
      "serialNumber": "TOTP123456",
      "manufacturer": "Contoso",
      "model": "Hardware Token 1000",
      "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
      "timeIntervalInSeconds": "30",
      "hashFunction": "hmacsha1"
      },
      {
        "@contentId": "2",
        "serialNumber": "TOTP654321",
        "manufacturer": "Contoso",
        "model": "Hardware Token 1000",
        "secretKey": "TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB",
        "timeIntervalInSeconds": "30",
        "hashFunction": "hmacsha1",
        "assignTo": {
          "id": "0cadbf92-####-####-####-############"
          }
      }
   ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;
using Microsoft.Kiota.Abstractions.Serialization;

var requestBody = new HardwareOathTokenAuthenticationMethodDevice
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"@context" , "#$delta"
		},
		{
			"value" , new List<object>
			{
				new UntypedObject(new Dictionary<string, UntypedNode>
				{
					{
						"@contentId", new UntypedString("1")
					},
					{
						"serialNumber", new UntypedString("TOTP123456")
					},
					{
						"manufacturer", new UntypedString("Contoso")
					},
					{
						"model", new UntypedString("Hardware Token 1000")
					},
					{
						"secretKey", new UntypedString("6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB")
					},
					{
						"timeIntervalInSeconds", new UntypedString("30")
					},
					{
						"hashFunction", new UntypedString("hmacsha1")
					},
				}),
				new UntypedObject(new Dictionary<string, UntypedNode>
				{
					{
						"@contentId", new UntypedString("2")
					},
					{
						"serialNumber", new UntypedString("TOTP654321")
					},
					{
						"manufacturer", new UntypedString("Contoso")
					},
					{
						"model", new UntypedString("Hardware Token 1000")
					},
					{
						"secretKey", new UntypedString("TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB")
					},
					{
						"timeIntervalInSeconds", new UntypedString("30")
					},
					{
						"hashFunction", new UntypedString("hmacsha1")
					},
					{
						"assignTo", new UntypedObject(new Dictionary<string, UntypedNode>
						{
							{
								"id", new UntypedString("0cadbf92-####-####-####-############")
							},
						})
					},
				}),
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.AuthenticationMethodDevices.HardwareOathDevices.PostAsync(requestBody);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta directory authentication-method-devices hardware-oath-devices create --body '{\
  "@context": "#$delta",\
  "value": [\
    {\
      "@contentId": "1",\
      "serialNumber": "TOTP123456",\
      "manufacturer": "Contoso",\
      "model": "Hardware Token 1000",\
      "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",\
      "timeIntervalInSeconds": "30",\
      "hashFunction": "hmacsha1"\
      },\
      {\
        "@contentId": "2",\
        "serialNumber": "TOTP654321",\
        "manufacturer": "Contoso",\
        "model": "Hardware Token 1000",\
        "secretKey": "TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB",\
        "timeIntervalInSeconds": "30",\
        "hashFunction": "hmacsha1",\
        "assignTo": {\
          "id": "0cadbf92-####-####-####-############"\
          }\
      }\
   ]\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

HardwareOathTokenAuthenticationMethodDevice hardwareOathTokenAuthenticationMethodDevice = new HardwareOathTokenAuthenticationMethodDevice();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("@context", "#$delta");
LinkedList<Object> value = new LinkedList<Object>();
 property = new ();
property.setContentId("1");
property.setSerialNumber("TOTP123456");
property.setManufacturer("Contoso");
property.setModel("Hardware Token 1000");
property.setSecretKey("6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB");
property.setTimeIntervalInSeconds("30");
property.setHashFunction("hmacsha1");
value.add(property);
 property1 = new ();
property1.setContentId("2");
property1.setSerialNumber("TOTP654321");
property1.setManufacturer("Contoso");
property1.setModel("Hardware Token 1000");
property1.setSecretKey("TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB");
property1.setTimeIntervalInSeconds("30");
property1.setHashFunction("hmacsha1");
 assignTo = new ();
assignTo.setId("0cadbf92-####-####-####-############");
property1.setAssignTo(assignTo);
value.add(property1);
additionalData.put("value", value);
hardwareOathTokenAuthenticationMethodDevice.setAdditionalData(additionalData);
HardwareOathTokenAuthenticationMethodDevice result = graphClient.directory().authenticationMethodDevices().hardwareOathDevices().post(hardwareOathTokenAuthenticationMethodDevice);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const hardwareOathTokenAuthenticationMethodDevice = {
  '@context': '#$delta',
  value: [
    {
      '@contentId': '1',
      serialNumber: 'TOTP123456',
      manufacturer: 'Contoso',
      model: 'Hardware Token 1000',
      secretKey: '6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB',
      timeIntervalInSeconds: '30',
      hashFunction: 'hmacsha1'
      },
      {
        '@contentId': '2',
        serialNumber: 'TOTP654321',
        manufacturer: 'Contoso',
        model: 'Hardware Token 1000',
        secretKey: 'TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB',
        timeIntervalInSeconds: '30',
        hashFunction: 'hmacsha1',
        assignTo: {
          id: '0cadbf92-####-####-####-############'
          }
      }
   ]
};

await client.api('/directory/authenticationMethodDevices/hardwareOathDevices')
	.version('beta')
	.post(hardwareOathTokenAuthenticationMethodDevice);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\HardwareOathTokenAuthenticationMethodDevice;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new HardwareOathTokenAuthenticationMethodDevice();
$additionalData = [
	'@context' => '#$delta',
	'value' => [
			[
				'@contentId' => '1',
				'serialNumber' => 'TOTP123456',
				'manufacturer' => 'Contoso',
				'model' => 'Hardware Token 1000',
				'secretKey' => '6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB',
				'timeIntervalInSeconds' => '30',
				'hashFunction' => 'hmacsha1',
			],
			[
				'@contentId' => '2',
				'serialNumber' => 'TOTP654321',
				'manufacturer' => 'Contoso',
				'model' => 'Hardware Token 1000',
				'secretKey' => 'TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB',
				'timeIntervalInSeconds' => '30',
				'hashFunction' => 'hmacsha1',
				'assignTo' => [
					'id' => '0cadbf92-####-####-####-############',
				],
			],
		],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->directory()->authenticationMethodDevices()->hardwareOathDevices()->post($requestBody)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	"@context" = "#$delta"
	value = @(
		@{
			"@contentId" = "1"
			serialNumber = "TOTP123456"
			manufacturer = "Contoso"
			model = "Hardware Token 1000"
			secretKey = "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB"
			timeIntervalInSeconds = "30"
			hashFunction = "hmacsha1"
		}
		@{
			"@contentId" = "2"
			serialNumber = "TOTP654321"
			manufacturer = "Contoso"
			model = "Hardware Token 1000"
			secretKey = "TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB"
			timeIntervalInSeconds = "30"
			hashFunction = "hmacsha1"
			assignTo = @{
				id = "0cadbf92-####-####-####-############"
			}
		}
	)
}

New-MgBetaDirectoryAuthenticationMethodDeviceHardwareOathDevice -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.hardware_oath_token_authentication_method_device import HardwareOathTokenAuthenticationMethodDevice
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = HardwareOathTokenAuthenticationMethodDevice(
	additional_data = {
			"@context" : "#$delta",
			"value" : [
				{
						"@content_id" : "1",
						"serial_number" : "TOTP123456",
						"manufacturer" : "Contoso",
						"model" : "Hardware Token 1000",
						"secret_key" : "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
						"time_interval_in_seconds" : "30",
						"hash_function" : "hmacsha1",
				},
				{
						"@content_id" : "2",
						"serial_number" : "TOTP654321",
						"manufacturer" : "Contoso",
						"model" : "Hardware Token 1000",
						"secret_key" : "TXYZAE6PJ4UZF3NNKIW3HQNFUF7WFTFB",
						"time_interval_in_seconds" : "30",
						"hash_function" : "hmacsha1",
						"assign_to" : {
								"id" : "0cadbf92-####-####-####-############",
						},
				},
			],
	}
)

result = await graph_client.directory.authentication_method_devices.hardware_oath_devices.post(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethod",
      "id": "aad49556-####-####-####-############",
      "device": {
        "id": "aad49556-####-####-####-############",
        "displayName": null,
        "serialNumber": "TOTP123456",
        "manufacturer": "Contoso",
        "model": "Hardware Token 1000",
        "secretKey": null,
        "timeIntervalInSeconds": 30,
        "status": "available",
        "hashFunction": "hmacsha1",
        "assignedTo": null
      }
    },
    {
      "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethod",
      "id": "3dee0e53-####-####-####-############",
      "device": {
        "id": "3dee0e53-####-####-####-############",
        "displayName": null,
        "serialNumber": "TOTP654321",
        "manufacturer": "Contoso",
        "model": "Hardware Token 1000",
        "secretKey": null,
        "timeIntervalInSeconds": 30,
        "status": "assigned",
        "hashFunction": "hmacsha1",
        "assignedTo": {
            "id": "0cadbf92-####-####-####-############",
            "displayName": "Amy Masters"
        }
      }
    }
  ]
}

次の方法で共有

1 つ以上の hardwareOathTokenAuthenticationMethodDevice オブジェクトを作成する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース