グループを作成するCreate group

2020/04/13

名前空間: microsoft.graphNamespace: microsoft.graph

要求本文で指定した新しいグループを作成します。Create a new group as specified in the request body. 次に示す種類のグループを作成できます。You can create the following types of groups:

Office 365 グループ (統合グループ)Office 365 group (unified group)
セキュリティグループSecurity group

この操作は既定で各グループのプロパティのサブセットのみを返します。This operation returns by default only a subset of the properties for each group. これらの既定のプロパティは、「プロパティ」セクションに記載されています。These default properties are noted in the Properties section.

既定で_返されない_プロパティを取得するには、GET 操作を実行し、$select OData クエリオプションでプロパティを指定します。To get properties that are not returned by default, do a GET operation and specify the properties in a $select OData query option.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type	アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account)	Group.ReadWrite.All、Directory.ReadWrite.All、Directory.AccessAsUser.AllGroup.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account)	サポートされていません。Not supported.
アプリケーションApplication	Group.Create、Group.ReadWrite.All、Directory.ReadWrite.AllGroup.Create, Group.ReadWrite.All, Directory.ReadWrite.All

HTTP 要求HTTP request

POST /groups

要求ヘッダーRequest headers

名前Name	種類Type	説明Description
AuthorizationAuthorization	stringstring	ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type	application/jsonapplication/json

要求本文Request body

次の表は、グループを作成するときに指定する group リソースのプロパティを示しています。The following table shows the properties of the group resource to specify when you create a group.

プロパティProperty	型Type	説明Description
displayNamedisplayName	stringstring	アドレス帳に表示するグループの名前。The name to display in the address book for the group. 最大長: 256 文字Maximum length: 256 characters. 必須です。Required.
descriptiondescription	stringstring	グループの説明A description for the group. 最大Max. 長: 1024 文字length: 1024 characters. 省略可能。Optional.
mailEnabledmailEnabled	booleanboolean	メールが有効なグループの場合は、true に設定します。Set to true for mail-enabled groups. 必須。Required.
mailNicknamemailNickname	stringstring	グループのメールエイリアス。The mail alias for the group. 最大Max. 長: 64 文字length: 64 characters. 必須です。Required.
securityEnabledsecurityEnabled	ブール値boolean	Office 365 グループを含む、セキュリティが有効なグループに true を設定します。Set to true for security-enabled groups, including Office 365 groups. 必須。Required.
ownersowners	string collectionstring collection	このプロパティは、作成時のグループの所有者を表します。This property represents the owners for the group at creation time. 省略可能。Optional.
membersmembers	string collectionstring collection	このプロパティは、作成時のグループのメンバーを表します。This property represents the members for the group at creation time. 省略可能。Optional.
visibilityvisibility	StringString	Office 365 グループの表示を指定します。Specifies the visibility of an Office 365 group. 使用可能な値は`Private`、 `Public`、 `HiddenMembership`、または空 (`Public` として解釈されます)。Possible values are: `Private`, `Public`, `HiddenMembership`, or empty (which is interpreted as `Public`).

グループの必要に応じて他の書き込み可能なプロパティを指定します。Specify other writable properties as necessary for your group. 詳細については、group リソースのプロパティをご覧ください。For more information, see the properties of the group resource.

groupTypes オプションgroupTypes options

示すように、groupTypes プロパティを使用し、グループの種類とグループのメンバーシップを管理します:Use the groupTypes property to control the type of group and its membership, as shown.

グループの種類Type of group	割り当て済みのメンバーシップAssigned membership	動的メンバーシップDynamic membership
Office 365 (統合グループともいいます)Office 365 (aka unified group)	`["Unified"]`	`["Unified","DynamicMembership"]`
DynamicDynamic	`[]` (null)`[]` (null)	`["DynamicMembership"]`

応答Response

成功した場合、このメソッドは 201 Created 応答コードと、応答本文で group オブジェクトを返します。If successful, this method returns a 201 Created response code and a group object in the response body. 応答には、そのグループの既定のプロパティのみが含まれます。The response includes only the default properties of the group.

例Examples

例 1: Office 365 グループを作成するExample 1: Create an Office 365 group

次の例では、Office 365 グループを作成します。The following example creates an Office 365 group.

要求Request

POST https://graph.microsoft.com/v1.0/groups
Content-type: application/json
Content-length: 244

{
  "description": "Self help community for library",
  "displayName": "Library Assist",
  "groupTypes": [
    "Unified"
  ],
  "mailEnabled": true,
  "mailNickname": "library",
  "securityEnabled": false
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = new Group
{
    Description = "Self help community for library",
    DisplayName = "Library Assist",
    GroupTypes = new List<String>()
    {
        "Unified"
    },
    MailEnabled = true,
    MailNickname = "library",
    SecurityEnabled = false
};

await graphClient.Groups
    .Request()
    .AddAsync(group);


const options = {
    authProvider,
};

const client = Client.init(options);

const group = {
  description: "Self help community for library",
  displayName: "Library Assist",
  groupTypes: [
    "Unified"
  ],
  mailEnabled: true,
  mailNickname: "library",
  securityEnabled: false
};

let res = await client.api('/groups')
    .post(group);


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/groups"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphGroup *group = [[MSGraphGroup alloc] init];
[group setDescription:@"Self help community for library"];
[group setDisplayName:@"Library Assist"];
NSMutableArray *groupTypesList = [[NSMutableArray alloc] init];
[groupTypesList addObject: @"Unified"];
[group setGroupTypes:groupTypesList];
[group setMailEnabled: true];
[group setMailNickname:@"library"];
[group setSecurityEnabled: false];

NSError *error;
NSData *groupData = [group getSerializedDataWithError:&error];
[urlRequest setHTTPBody:groupData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];


IGraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Group group = new Group();
group.description = "Self help community for library";
group.displayName = "Library Assist";
LinkedList<String> groupTypesList = new LinkedList<String>();
groupTypesList.add("Unified");
group.groupTypes = groupTypesList;
group.mailEnabled = true;
group.mailNickname = "library";
group.securityEnabled = false;

graphClient.groups()
    .buildRequest()
    .post(group);

応答Response

応答の例を次に示します。The following is an example of the response.

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

{
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
      "deletedDateTime": null,
      "classification": null,
      "createdDateTime": "2018-12-22T00:51:37Z",
      "creationOptions": [],
      "description": "Self help community for library",
      "displayName": "Library Assist",
      "groupTypes": [
          "Unified"
      ],
      "mail": "library7423@contoso.com",
      "mailEnabled": true,
      "mailNickname": "library",
      "onPremisesLastSyncDateTime": null,
      "onPremisesSecurityIdentifier": null,
      "onPremisesSyncEnabled": null,
      "preferredDataLocation": "CAN",
      "proxyAddresses": [
          "SMTP:library7423@contoso.com"
      ],
      "renewedDateTime": "2018-12-22T00:51:37Z",
      "resourceBehaviorOptions": [],
      "resourceProvisioningOptions": [],
      "securityEnabled": false,
      "visibility": "Public",
      "onPremisesProvisioningErrors": []
}

例 2: 所有者とメンバーを指定してグループを作成するExample 2: Create a group with owners and members

次の例では、所有者とメンバーを指定して Office 365 グループを作成しています。The following example creates an Office 365 group with an owner and members specified. グループ作成の一部として、所有者やメンバーなどの最大 20 個の関係を追加できます。Note that a maximum of 20 relationships, such as owners and members, can be added as part of group creation. その後、メンバーの追加 API または JSON バッチ処理を使用して、さらにメンバーを追加できます。You can subsequently add more members by using the add member API or JSON batching.

要求Request

POST https://graph.microsoft.com/v1.0/groups
Content-Type: application/json

{
  "description": "Group with designated owner and members",
  "displayName": "Operations group",
  "groupTypes": [
    "Unified"
  ],
  "mailEnabled": true,
  "mailNickname": "operations2019",
  "securityEnabled": false,
  "owners@odata.bind": [
    "https://graph.microsoft.com/v1.0/users/26be1845-4119-4801-a799-aea79d09f1a2"
  ],
  "members@odata.bind": [
    "https://graph.microsoft.com/v1.0/users/ff7cb387-6688-423c-8188-3da9532a73cc",
    "https://graph.microsoft.com/v1.0/users/69456242-0067-49d3-ba96-9de6f2728e14"
  ]
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = new Group
{
    Description = "Group with designated owner and members",
    DisplayName = "Operations group",
    GroupTypes = new List<String>()
    {
        "Unified"
    },
    MailEnabled = true,
    MailNickname = "operations2019",
    SecurityEnabled = false,
    AdditionalData = new Dictionary<string, object>()
    {
        {"owners@odata.bind", "[\"https://graph.microsoft.com/v1.0/users/26be1845-4119-4801-a799-aea79d09f1a2\"]"},
        {"members@odata.bind", "[\"https://graph.microsoft.com/v1.0/users/ff7cb387-6688-423c-8188-3da9532a73cc\",\"https://graph.microsoft.com/v1.0/users/69456242-0067-49d3-ba96-9de6f2728e14\"]"}
    }
};

await graphClient.Groups
    .Request()
    .AddAsync(group);


const options = {
    authProvider,
};

const client = Client.init(options);

const group = {
  description: "Group with designated owner and members",
  displayName: "Operations group",
  groupTypes: [
    "Unified"
  ],
  mailEnabled: true,
  mailNickname: "operations2019",
  securityEnabled: false,
  owners@odata.bind: [
    "https://graph.microsoft.com/v1.0/users/26be1845-4119-4801-a799-aea79d09f1a2"
  ],
  members@odata.bind: [
    "https://graph.microsoft.com/v1.0/users/ff7cb387-6688-423c-8188-3da9532a73cc",
    "https://graph.microsoft.com/v1.0/users/69456242-0067-49d3-ba96-9de6f2728e14"
  ]
};

let res = await client.api('/groups')
    .post(group);


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/groups"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphGroup *group = [[MSGraphGroup alloc] init];
[group setDescription:@"Group with designated owner and members"];
[group setDisplayName:@"Operations group"];
NSMutableArray *groupTypesList = [[NSMutableArray alloc] init];
[groupTypesList addObject: @"Unified"];
[group setGroupTypes:groupTypesList];
[group setMailEnabled: true];
[group setMailNickname:@"operations2019"];
[group setSecurityEnabled: false];

NSError *error;
NSData *groupData = [group getSerializedDataWithError:&error];
[urlRequest setHTTPBody:groupData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];


IGraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Group group = new Group();
group.description = "Group with designated owner and members";
group.displayName = "Operations group";
LinkedList<String> groupTypesList = new LinkedList<String>();
groupTypesList.add("Unified");
group.groupTypes = groupTypesList;
group.mailEnabled = true;
group.mailNickname = "operations2019";
group.securityEnabled = false;
group.additionalDataManager().put("owners@odata.bind", new JsonPrimitive("[
  "https://graph.microsoft.com/v1.0/users/26be1845-4119-4801-a799-aea79d09f1a2"
]"));
group.additionalDataManager().put("members@odata.bind", new JsonPrimitive("[
  "https://graph.microsoft.com/v1.0/users/ff7cb387-6688-423c-8188-3da9532a73cc",
  "https://graph.microsoft.com/v1.0/users/69456242-0067-49d3-ba96-9de6f2728e14"
]"));

graphClient.groups()
    .buildRequest()
    .post(group);

応答Response

成功応答の例を次に示します。The following is an example of a successful response. 既定のプロパティのみが含まれています。It includes only default properties. その後は、グループの owners ナビゲーションプロパティまたは members ナビゲーションプロパティを取得して所有者またはメンバーの詳細を確認できます。You can subsequently get the owners or members navigation properties of the group to verify the owner or members.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
    "id": "502df398-d59c-469d-944f-34a50e60db3f",
    "deletedDateTime": null,
    "classification": null,
    "createdDateTime": "2018-12-27T22:17:07Z",
    "creationOptions": [],
    "description": "Group with designated owner and members",
    "displayName": "Operations group",
    "groupTypes": [
        "Unified"
    ],
    "mail": "operations2019@contoso.com",
    "mailEnabled": true,
    "mailNickname": "operations2019",
    "onPremisesLastSyncDateTime": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSyncEnabled": null,
    "preferredDataLocation": "CAN",
    "proxyAddresses": [
        "SMTP:operations2019@contoso.com"
    ],
    "renewedDateTime": "2018-12-27T22:17:07Z",
    "resourceBehaviorOptions": [],
    "resourceProvisioningOptions": [],
    "securityEnabled": false,
    "visibility": "Public",
    "onPremisesProvisioningErrors": []
}

グループを作成するCreate group

アクセス許可Permissions

HTTP 要求HTTP request

要求ヘッダーRequest headers

要求本文Request body

groupTypes オプションgroupTypes options

応答Response

例Examples

例 1: Office 365 グループを作成するExample 1: Create an Office 365 group

要求Request

応答Response

例 2: 所有者とメンバーを指定してグループを作成するExample 2: Create a group with owners and members

要求Request

応答Response

このページはお役に立ちましたか?

このページはお役に立ちましたか?