更新组织

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

更新当前经过身份验证的组织的属性。 在这种情况下, organization 定义为恰好一条记录的集合,因此必须在请求中指定其 ID 。 该 ID 也称为组织的 tenantId

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

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

权限

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

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

还必须至少为呼叫用户分配计费管理员Microsoft Entra角色

若要更新 onPremisesSyncEnabled 属性,必须至少为调用用户分配以下Microsoft Entra角色之一:

  • 目录同步帐户
  • 混合标识管理员

HTTP 请求

PATCH /organization/{id}

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json

请求正文

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

属性 类型 说明
businessPhones 字符串集合 组织的电话号码。 虽然这是字符串集合,但是只能为该属性设置一个号码。
城市 String 组织地址所在的城市名称。
marketingNotificationEmails String 集合 注意:不可为 null。
onPremisesSyncEnabled Boolean true 若要从本地目录同步此对象,则为 ; false 若要禁用从本地目录同步,则为 ;空。 null 如果此对象从未从本地目录(默认)进行同步。
postalCode String 组织地址的邮政编码。
preferredLanguage String 组织的首选语言。 应遵循 ISO 639-1 代码;例如,en。
privacyProfile privacyProfile 组织的隐私配置文件(设置 statementUrl 和 contactEmail)。
securityComplianceNotificationMails String collection
securityComplianceNotificationPhones String collection
state String 组织地址所在的省/自治区/直辖市名称。
street String 组织地址所在的街道名称。
technicalNotificationMails String 集合 注意:不可为 null。

由于 组织 资源支持 扩展,因此可以使用 PATCH 操作在现有 组织 实例中扩展的自定义属性中添加、更新或删除自己的特定于应用的数据。

响应

如果成功,此方法返回 204 No Content 响应代码。 它不会在响应正文中返回任何内容。

示例

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/beta/organization/84841066-274d-4ec0-a5c1-276be684bdd3
Content-type: application/json

{
  "marketingNotificationEmails" : ["marketing@contoso.com"],
  "onPremisesSyncEnabled" : true,
  "privacyProfile" :
    {
      "contactEmail":"alice@contoso.com",
      "statementUrl":"https://contoso.com/privacyStatement"
    },
  "securityComplianceNotificationMails" : ["security@contoso.com"],
  "securityComplianceNotificationPhones" : ["(123) 456-7890"],
  "technicalNotificationMails" : ["tech@contoso.com"]
}
响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content