命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
创建新的 externalAuthenticationMethod 对象。 此 API 不支持自助服务作。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
UserAuthMethod-External.ReadWrite.All |
UserAuthenticationMethod.ReadWrite、UserAuthenticationMethod.ReadWrite.All |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
UserAuthMethod-External.ReadWrite.All |
UserAuthenticationMethod.ReadWrite.All |
重要
在具有工作或学校帐户的委托方案中,如果已登录用户对其他用户进行作,则必须为他们分配受支持的Microsoft Entra角色或具有受支持角色权限的自定义角色。 此作支持以下最低特权角色。
HTTP 请求
将外部身份验证方法分配给其他用户。 此 API 不支持自助服务作。
POST /users/{usersId}/authentication/externalAuthenticationMethods
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供 externalAuthenticationMethod 对象的 JSON 表示形式。
创建 externalAuthenticationMethod 时,可以指定以下属性。
| 属性 |
类型 |
说明 |
| configurationId |
String |
用于管理和集成Microsoft Entra ID 中的外部身份验证方法的唯一标识符。 必填。 |
| displayName |
String |
为已注册的外部身份验证方法提供的自定义名称。 必填。 |
响应
如果成功,此方法在 201 Created 响应正文中返回响应代码和 externalAuthenticationMethod 对象。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/users/{id}/authentication/externalAuthenticationMethods
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalAuthenticationMethod",
"configurationId": "26310fee-860b-4eab-8749-ab730dcf335e",
"displayName": "Adatum"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new ExternalAuthenticationMethod
{
OdataType = "#microsoft.graph.externalAuthenticationMethod",
ConfigurationId = "26310fee-860b-4eab-8749-ab730dcf335e",
DisplayName = "Adatum",
};
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Authentication.ExternalAuthenticationMethods.PostAsync(requestBody);
// 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"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewExternalAuthenticationMethod()
configurationId := "26310fee-860b-4eab-8749-ab730dcf335e"
requestBody.SetConfigurationId(&configurationId)
displayName := "Adatum"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=go
externalAuthenticationMethods, err := graphClient.Users().ByUserId("user-id").Authentication().ExternalAuthenticationMethods().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ExternalAuthenticationMethod externalAuthenticationMethod = new ExternalAuthenticationMethod();
externalAuthenticationMethod.setOdataType("#microsoft.graph.externalAuthenticationMethod");
externalAuthenticationMethod.setConfigurationId("26310fee-860b-4eab-8749-ab730dcf335e");
externalAuthenticationMethod.setDisplayName("Adatum");
ExternalAuthenticationMethod result = graphClient.users().byUserId("{user-id}").authentication().externalAuthenticationMethods().post(externalAuthenticationMethod);
const options = {
authProvider,
};
const client = Client.init(options);
const externalAuthenticationMethod = {
'@odata.type': '#microsoft.graph.externalAuthenticationMethod',
configurationId: '26310fee-860b-4eab-8749-ab730dcf335e',
displayName: 'Adatum'
};
await client.api('/users/{id}/authentication/externalAuthenticationMethods')
.version('beta')
.post(externalAuthenticationMethod);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\ExternalAuthenticationMethod;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ExternalAuthenticationMethod();
$requestBody->setOdataType('#microsoft.graph.externalAuthenticationMethod');
$requestBody->setConfigurationId('26310fee-860b-4eab-8749-ab730dcf335e');
$requestBody->setDisplayName('Adatum');
$result = $graphServiceClient->users()->byUserId('user-id')->authentication()->externalAuthenticationMethods()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.externalAuthenticationMethod"
configurationId = "26310fee-860b-4eab-8749-ab730dcf335e"
displayName = "Adatum"
}
New-MgBetaUserAuthenticationExternalAuthenticationMethod -UserId $userId -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.models.external_authentication_method import ExternalAuthenticationMethod
# To initialize your graph_client, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ExternalAuthenticationMethod(
odata_type = "#microsoft.graph.externalAuthenticationMethod",
configuration_id = "26310fee-860b-4eab-8749-ab730dcf335e",
display_name = "Adatum",
)
result = await graph_client.users.by_user_id('user-id').authentication.external_authentication_methods.post(request_body)
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalAuthenticationMethod",
"id": "78381c69-811f-51f6-66ec-c2c2aa0e2b46",
"createdDateTime": "2025-04-02T16:01:39",
"configurationId": "26310fee-860b-4eab-8749-ab730dcf335e",
"displayName": "Adatum"
}