グループを作成

post

https://api.box.com/2.0

/groups

会社内に新しいユーザーグループを作成します。新しいグループを作成できるのは、管理者権限を持つユーザーのみです。

リクエスト

Content-Typeapplication/json

クエリパラメータ

fieldsstring arrayクエリ内省略可能

例id,type,name

応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

リクエスト本文

description string本文内省略可能

例"Customer Support Group - as imported from Active Directory"最大長255

グループについての人間が判読できる説明。

external_sync_identifier string本文内省略可能

例AD:123456

このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。

このフィールドの値には、Active DirectoryオブジェクトIDやGoogleグループIDなどを使用できます。

Boxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。

invitability_level string本文内省略可能

例admins_only

フォルダでのコラボレーションにグループを招待できるユーザーを指定します。

admins_onlyに設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。

admins_and_membersに設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。

all_managed_usersに設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。

次の値のいずれか1つ: admins_only,admins_and_members,all_managed_users

member_viewability_level string本文内省略可能

例admins_only

グループのメンバーを表示できるユーザーを指定します。

admins_only - 会社の管理者、共同管理者、グループのグループ管理者
admins_and_members - すべての管理者とグループメンバー
all_managed_users - 会社内のすべての管理対象ユーザー

次の値のいずれか1つ: admins_only,admins_and_members,all_managed_users

name string本文内必須

例Customer Support

作成する新しいグループの名前。この名前は、会社内で一意である必要があります。

provenance string本文内省略可能

例Active Directory最大長255

Active DirectoryやOktaなど、このグループの元になっている外部ソースを追跡します。

また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。

これはグループを一方向にのみ同期する場合に適しています。

レスポンス

201application/jsonGroup

新しいグループオブジェクトを返します。

409application/jsonクライアントエラー

競合が原因でグループを作成できないことを示すエラーを返します。

invalid_parameter: グループ名が会社内で一意でない場合によく返されます。

defaultapplication/jsonクライアントエラー

予期しないクライアントエラー。

post

グループを作成

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -X POST https://api.box.com/2.0/groups \
     -H 'Authorization: Bearer <ACCESS_TOKEN>" '
     -H 'Content-Type: application/json" '
     -d '{
       "name": "Customer Support"
     }'

.NET

var groupParams = new BoxGroupRequest()
{
    Name = "Engineers"
};
BoxGroup group = await client.GroupsManager.CreateAsync(groupParams);

Java

BoxGroup.Info groupInfo = BoxGroup.createGroup(api, "My Group");

Python

created_group = client.create_group('Example Group')
print('Created group with ID {0}'.format(created_group.id))

Node

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' }
		*/
	});

iOS

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")
 }