更新 userSettings

命名空间：microsoft.graph

更新 userSettings 对象的属性。 同一组织中的用户可以根据其首选项或组织策略使用不同的设置。 若要获取用户当前设置，请参阅 当前用户设置。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

批量请求

还可以从 Delve 中选择退出多个用户，并通过批处理请求禁用他们对整个组织的内容相关性的贡献。 若要了解详细信息，请参阅 JSON 批处理。

重要提示：只有 组织管理 角色组的成员才能更新多个用户。

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	User.ReadWrite	User.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	不支持。	不支持。

HTTP 请求

PATCH /me/settings

具有“用户ID”或“userPrincipalName”的请求只能由用户或具有 User.ReadWrite.All 权限的用户访问。 若要了解详细信息，请参阅权限。

PATCH /users/{id | userPrincipalName}/settings/

请求标头

标头	值
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type	application/json

请求正文

在请求正文中，提供应更新的相关字段的值。 请求正文中未包含的现有属性会保留其以前的值，或者根据对其他属性值的更改重新计算。 为了实现最佳性能，不得添加尚未变化的现有值。

属性	类型	说明
contributionToContentDiscoveryDisabled	布尔值	设置为 true 可禁用对 热门 API 的 委托访问，并禁用用户对 Office Delve 中文档的访问。 将 设置为 true 还会影响 Microsoft 365 中显示的内容的相关性，例如 SharePoint 主页中的“建议网站”和“发现”视图OneDrive for Business显示不太相关的结果。 此设置反映 Office Delve 中的控件状态。

响应

如果成功，此方法在响应正文中返回响应 200 OK 代码和更新的 userSettings 。

示例

请求

下面是有关如何从 Delve 中选择退出用户并禁用他们对整个组织内容相关性的贡献的示例请求。

HTTP

PATCH https://graph.microsoft.com/v1.0/me/settings
Content-type: application/json

{
  "contributionToContentDiscoveryDisabled": true
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new UserSettings
{
	ContributionToContentDiscoveryDisabled = true,
};

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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users settings patch --user-id {user-id} --body '{\
  "contributionToContentDiscoveryDisabled": true\
}\
'

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewUserSettings()
contributionToContentDiscoveryDisabled := true
requestBody.SetContributionToContentDiscoveryDisabled(&contributionToContentDiscoveryDisabled) 

settings, err := graphClient.Me().Settings().Patch(context.Background(), requestBody, nil)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

UserSettings userSettings = new UserSettings();
userSettings.setContributionToContentDiscoveryDisabled(true);
UserSettings result = graphClient.me().settings().patch(userSettings);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const userSettings = {
  contributionToContentDiscoveryDisabled: true
};

await client.api('/me/settings')
	.update(userSettings);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\UserSettings;


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

$requestBody = new UserSettings();
$requestBody->setContributionToContentDiscoveryDisabled(true);

$result = $graphServiceClient->me()->settings()->patch($requestBody)->wait();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Users

$params = @{
	contributionToContentDiscoveryDisabled = $true
}

# A UPN can also be used as -UserId.
Update-MgUserSetting -UserId $userId -BodyParameter $params

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.user_settings import UserSettings

graph_client = GraphServiceClient(credentials, scopes)

request_body = UserSettings(
	contribution_to_content_discovery_disabled = True,
)

result = await graph_client.me.settings.patch(request_body)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

以下示例显示了相应的响应。 注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('c771-00aa-4fa0-92ac-905f')/settings/$entity",
  "contributionToContentDiscoveryAsOrganizationDisabled": false,
  "contributionToContentDiscoveryDisabled": true
}