グループを作成
会社内に新しいユーザーグループを作成します。新しいグループを作成できるのは、管理者権限を持つユーザーのみです。
リクエスト
クエリパラメータ
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
リクエスト本文
""Customer Support Group - as imported from Active Directory""255グループについての人間が判読できる説明。
"AD:123456"このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。
このフィールドの値には、Active DirectoryオブジェクトIDやGoogleグループIDなどを使用できます。
Boxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。
"admins_only"フォルダでのコラボレーションにグループを招待できるユーザーを指定します。
admins_onlyに設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。
admins_and_membersに設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。
all_managed_usersに設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。
次の値のいずれか1つ: admins_only,admins_and_members,all_managed_users
"admins_only"グループのメンバーを表示できるユーザーを指定します。
admins_only- 企業の管理者、共同管理者、グループのグループ管理者admins_and_members- すべての管理者とグループメンバーall_managed_users- 企業のすべての管理対象ユーザー
次の値のいずれか1つ: admins_only,admins_and_members,all_managed_users
"Customer Support"作成する新しいグループの名前。この名前は、企業内で一意である必要があります。
"Active Directory"255Active DirectoryやOktaなど、このグループの元になっている外部ソースを追跡します。
また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。
これはグループを一方向にのみ同期する場合に適しています。
レスポンス
新しいグループオブジェクトを返します。
競合が原因でグループを作成できないことを示すエラーを返します。
invalid_parameter: グループ名が企業内で一意でない場合によく返されます。
予期しないクライアントエラー。
リクエストの例
curl -i -X POST "https://api.box.com/2.0/groups" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"name": "Customer Support"
}'await client.groups.createGroup({
name: groupName,
description: groupDescription,
} satisfies CreateGroupRequestBody);client.groups.create_group(group_name, description=group_description)await client.Groups.CreateGroupAsync(requestBody: new CreateGroupRequestBody(name: groupName) { Description = groupDescription });BoxGroup.Info groupInfo = BoxGroup.createGroup(api, "My Group");created_group = client.create_group('Example Group')
print(f'Created group with ID {created_group.id}')var groupParams = new BoxGroupRequest()
{
Name = "Engineers"
};
BoxGroup group = await client.GroupsManager.CreateAsync(groupParams);client.groups.create('My group', {description: 'An example group'})
.then(group => {
/* group -> {
type: 'group',
id: '119720',
name: 'Box Employees',
created_at: '2013-05-16T15:27:57-07:00',
modified_at: '2013-05-16T15:27:57-07:00' }
*/
});client.groups.create(name: "Team A", provenance: "Test", externalSyncIdentifier: "Test Sync", description: "Test Description", invitabilityLevel: .allManagedUsers, memberViewabilityLevel: .allManagedUsers) { (result: Result<Group, BoxSDKError>) in
guard case let .success(group) = result else {
print("Error creating new group")
return
}
print("Group \(group.name) was created")
}レスポンスの例
{
"id": "11446498",
"type": "group",
"created_at": "2012-12-12T10:53:43-08:00",
"description": "Support Group - as imported from Active Directory",
"external_sync_identifier": "AD:123456",
"group_type": "managed_group",
"invitability_level": "admins_only",
"member_viewability_level": "admins_only",
"modified_at": "2012-12-12T10:53:43-08:00",
"name": "Support",
"permissions": {
"can_invite_as_collaborator": true
},
"provenance": "Active Directory"
}