命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
更新租户范围的 externalIdentitiesPolicy 对象的设置,该对象控制外部用户是否可以通过自助服务控件离开Microsoft Entra租户。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
Policy.ReadWrite.ExternalIdentities |
不可用。 |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
Policy.ReadWrite.ExternalIdentities |
不可用。 |
HTTP 请求
PATCH /policies/externalIdentitiesPolicy
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
application/json. 必需。 |
请求正文
在请求正文中, 仅 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。
下表指定可更新的属性。
| 属性 |
类型 |
说明 |
| allowDeletedIdentitiesDataRemoval |
布尔值 |
保留以供将来使用。 |
| allowExternalIdentitiesToLeave |
布尔值 |
定义外部用户是否可以离开来宾租户。 如果设置为 false,则禁用自助服务控制,并且来宾租户的管理员必须手动从来宾租户中删除外部用户。 当外部用户离开租户时,先软删除其来宾租户中的数据,然后在 30 天内永久删除。 必填。 |
响应
如果成功,此方法返回 204 No Content 响应代码。 它不会在响应正文中返回任何内容。
示例
请求
PATCH https://graph.microsoft.com/beta/policies/externalIdentitiesPolicy
{
"allowExternalIdentitiesToLeave":false
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new ExternalIdentitiesPolicy
{
AllowExternalIdentitiesToLeave = false,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Policies.ExternalIdentitiesPolicy.PatchAsync(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.NewExternalIdentitiesPolicy()
allowExternalIdentitiesToLeave := false
requestBody.SetAllowExternalIdentitiesToLeave(&allowExternalIdentitiesToLeave)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
externalIdentitiesPolicy, err := graphClient.Policies().ExternalIdentitiesPolicy().Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ExternalIdentitiesPolicy externalIdentitiesPolicy = new ExternalIdentitiesPolicy();
externalIdentitiesPolicy.setAllowExternalIdentitiesToLeave(false);
ExternalIdentitiesPolicy result = graphClient.policies().externalIdentitiesPolicy().patch(externalIdentitiesPolicy);
const options = {
authProvider,
};
const client = Client.init(options);
const externalIdentitiesPolicy = {
allowExternalIdentitiesToLeave: false
};
await client.api('/policies/externalIdentitiesPolicy')
.version('beta')
.update(externalIdentitiesPolicy);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\ExternalIdentitiesPolicy;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ExternalIdentitiesPolicy();
$requestBody->setAllowExternalIdentitiesToLeave(false);
$result = $graphServiceClient->policies()->externalIdentitiesPolicy()->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
allowExternalIdentitiesToLeave = $false
}
Update-MgBetaPolicyExternalIdentityPolicy -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_identities_policy import ExternalIdentitiesPolicy
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ExternalIdentitiesPolicy(
allow_external_identities_to_leave = False,
)
result = await graph_client.policies.external_identities_policy.patch(request_body)
响应
HTTP/1.1 204 No Content