命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
激活已分配给用户 的硬件 OATH 令牌 。 用户可以自行激活其令牌,或者管理员可以为用户激活令牌。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
针对自身作的权限
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
UserAuthenticationMethod.ReadWrite |
UserAuthenticationMethod.ReadWrite.All |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
不支持。 |
不支持。 |
对其他用户进行作的权限
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
UserAuthenticationMethod.ReadWrite.All |
不可用。 |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
UserAuthenticationMethod.ReadWrite.All |
不可用。 |
重要
在具有工作或学校帐户的委托方案中,如果已登录用户对其他用户进行作,则必须为他们分配受支持的Microsoft Entra角色或具有受支持角色权限的自定义角色。 此作支持以下最低特权角色。
HTTP 请求
激活分配给你的硬件 OATH 身份验证方法。
POST /me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}/activate
注意
调用 /me
终结点需要已登录的用户,因此需要委派权限。 使用 /me
终结点时,不支持应用程序权限。
激活分配给其他用户的硬件 OATH 身份验证方法。
POST /users/{usersId}/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}/activate
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供参数的 JSON 表示形式。
下表列出了调用此作时所需的参数。
参数 |
类型 |
说明 |
verificationCode |
String |
硬件 OATH 令牌上每 30 或 60 秒刷新一次的 6 位 TOTP 代码。 |
displayName |
String |
可提供给硬件 OATH 令牌的可选名称。 |
响应
如果成功,此操作返回 204 No Content
响应代码。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}/activate
Content-Type: application/json
{
"verificationCode": "588651",
"displayName": "Amy Masters Token"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Me.Authentication.HardwareOathMethods.Item.Activate;
var requestBody = new ActivatePostRequestBody
{
VerificationCode = "588651",
DisplayName = "Amy Masters Token",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Authentication.HardwareOathMethods["{hardwareOathAuthenticationMethod-id}"].Activate.PostAsync(requestBody);
mgc-beta users authentication hardware-oath-methods activate post --user-id {user-id} --hardware-oath-authentication-method-id {hardwareOathAuthenticationMethod-id} --body '{\
"verificationCode": "588651",\
"displayName": "Amy Masters Token"\
}\
'
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
//other-imports
)
requestBody := graphusers.NewItemActivatePostRequestBody()
verificationCode := "588651"
requestBody.SetVerificationCode(&verificationCode)
displayName := "Amy Masters Token"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Authentication().HardwareOathMethods().ByHardwareOathAuthenticationMethodId("hardwareOathAuthenticationMethod-id").Activate().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.users.item.authentication.hardwareoathmethods.item.activate.ActivatePostRequestBody activatePostRequestBody = new com.microsoft.graph.beta.users.item.authentication.hardwareoathmethods.item.activate.ActivatePostRequestBody();
activatePostRequestBody.setVerificationCode("588651");
activatePostRequestBody.setDisplayName("Amy Masters Token");
graphClient.me().authentication().hardwareOathMethods().byHardwareOathAuthenticationMethodId("{hardwareOathAuthenticationMethod-id}").activate().post(activatePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const activate = {
verificationCode: '588651',
displayName: 'Amy Masters Token'
};
await client.api('/me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}/activate')
.version('beta')
.post(activate);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\Authentication\HardwareOathMethods\Item\Activate\ActivatePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ActivatePostRequestBody();
$requestBody->setVerificationCode('588651');
$requestBody->setDisplayName('Amy Masters Token');
$graphServiceClient->me()->authentication()->hardwareOathMethods()->byHardwareOathAuthenticationMethodId('hardwareOathAuthenticationMethod-id')->activate()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
verificationCode = "588651"
displayName = "Amy Masters Token"
}
# A UPN can also be used as -UserId.
Initialize-MgBetaUserAuthenticationHardwareOathMethod -UserId $userId -HardwareOathAuthenticationMethodId $hardwareOathAuthenticationMethodId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.authentication.hardwareoathmethods.item.activate.activate_post_request_body import ActivatePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ActivatePostRequestBody(
verification_code = "588651",
display_name = "Amy Masters Token",
)
await graph_client.me.authentication.hardware_oath_methods.by_hardware_oath_authentication_method_id('hardwareOathAuthenticationMethod-id').activate.post(request_body)
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 204 No Content