添加成员

命名空间:microsoft.graph

重要

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

使用此 API 可向管理单元添加成员 (用户、组或设备) ,或在管理单元内创建新组。 可以在管理单元中创建所有 组类型

注意: 目前,一次只能将一个成员添加到管理单元。

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

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

权限

要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限

添加现有用户、组或设备的权限

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

若要将用户、组或设备添加到管理单元,必须为调用用户分配特权角色管理员Microsoft Entra角色

创建新组的权限

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

若要在管理单元中创建新组,必须为调用用户分配特权角色管理员组管理员Microsoft Entra角色

HTTP 请求

以下请求将现有用户、组或设备添加到管理单元。

POST /administrativeUnits/{id}/members/$ref

以下请求在管理单元中创建一个新组。

POST /administrativeUnits/{id}/members

请求标头

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

添加现有用户或组

在请求正文中,提供 id 要添加 的用户设备directoryObject 的 。 如果管理单元是受限管理管理单元 (isMemberManagementRestricted=true) ,则组类型必须是Microsoft Entra安全组。 仅支持启用了安全性、未启用邮件和未启用本地同步的非统一组。

创建新组

下表显示了在管理单元中创建 时要指定的组资源的属性。

属性 类型 说明
displayName string 要在组的通讯簿中显示的名称。 必需。
description string 组说明。 可选。
isAssignableToRole Boolean 将 设置为 true 以启用要分配给Microsoft Entra角色的组。 只有特权角色管理员和全局管理员才能设置此属性的值。 可选。
mailEnabled 布尔 对于已启用邮件的组,请设置为 true。 必需。
mailNickname string 组的邮件别名。 无法在 mailNickName 中使用这些字符:@()\[]";:.<>,SPACE。 必填。
securityEnabled boolean 对于启用安全机制的组(包括 Microsoft 365 组),请设置为 true。 必填。
owners directoryObject collection 此属性表示创建时指定的组所有者。 可选。
members directoryObject collection 此属性表示创建时指定的组成员。 可选。
visibility String 指定 Microsoft 365 组的可见性。 可能的值是:PrivatePublicHiddenMembership 或空(解释为 Public)。

响应

如果成功,使用 $ref) 添加现有对象 (将 204 No Content 返回响应代码。 它不会在响应正文中返回任何内容。

在没有) 的情况下 $ref 创建新组 (时,此方法在响应正文中返回 201 Created 响应代码和 对象。 该响应仅包括组的默认属性。 必须在请求正文中提供 "@odata.type" : "#microsoft.graph.group" 行,才能将新成员显式标识为组。 没有正确 @odata.type 项的请求正文将 400 Bad Request 返回错误消息。

示例

示例 1:添加现有用户或组

以下操作会将现有用户或组添加到管理单元。

请求

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

POST https://graph.microsoft.com/beta/administrativeUnits/{id}/members/$ref
Content-type: application/json

{
  "@odata.id":"https://graph.microsoft.com/beta/groups/{id}"
}

在请求正文中,提供 id 要添加 的用户设备 对象的 。

响应

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

HTTP/1.1 204 No Content

示例 2:创建新组

以下示例在管理单元中创建一个新组。 必须在请求正文中提供 "@odata.type" : "#microsoft.graph.group" 行,才能将新成员显式标识为组。 没有正确 @odata.type 项的请求正文将 400 Bad Request 返回错误消息。

请求

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

POST https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.group",
  "description": "Self help community for golf",
  "displayName": "Golf Assist",
  "groupTypes": [
    "Unified"
  ],
  "mailEnabled": true,
  "mailNickname": "golfassist",
  "securityEnabled": false
}

在请求正文中,提供要添加的 对象的属性。

响应

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

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
   "@odata.context": "https://graph.microsoft.com/beta/$metadata#groups/$entity",
     "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
     "deletedDateTime": null,
     "classification": null,
     "createdDateTime": "2018-12-22T02:21:05Z",
     "description": "Self help community for golf",
     "displayName": "Golf Assist",
     "expirationDateTime": null,
     "groupTypes": [
         "Unified"
     ],
   "isAssignableToRole": null,
     "mail": "golfassist@contoso.com",
     "mailEnabled": true,
     "mailNickname": "golfassist",
     "membershipRule": null,
     "membershipRuleProcessingState": null,
     "onPremisesLastSyncDateTime": null,
     "onPremisesSecurityIdentifier": null,
     "onPremisesSyncEnabled": null,
     "preferredDataLocation": "CAN",
     "preferredLanguage": null,
     "proxyAddresses": [
         "SMTP:golfassist@contoso.com"
     ],
     "renewedDateTime": "2018-12-22T02:21:05Z",
     "resourceBehaviorOptions": [],
     "resourceProvisioningOptions": [],
     "securityEnabled": false,
   "securityIdentifier": "S-1-12-1-1753967289-1089268234-832641959-555555555",
     "theme": null,
     "visibility": "Public",
     "onPremisesProvisioningErrors": []
}