グループを更新

put

https://api.box.com/2.0

/groups/:group_id/

特定のグループを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。

リクエスト

AuthorizationBearer [ACCESS_TOKEN]

Content-Typeapplication/json

パスパラメータ

group_id stringパス内必須

例57645

グループのID。

クエリパラメータ

fields string 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ウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。

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

レスポンス

200application/jsonGroup (標準)

更新されたグループオブジェクトを返します。

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

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

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

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

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

put

グループを更新

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

ログイン

リクエストの例

cURL

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

.NET

var updates = new BoxGroupRequest()
{
    Name = "New group name"
};
BoxGroup updatedGroup = await client.GroupsManager.UpdateAsync("11111", updates);

Java

BoxGroup group = new BoxGroup(api, id);
BoxGroup.Info groupInfo = group.getInfo();
groupInfo.addPendingChange("name", "New name for My Group");
group.updateInfo(groupInfo);

Python

group_update = {'name': 'New Group Name'}
updated_group = client.group(group_id='11111').update_info(group_update)
print('Changed the name of group {0} to "{1}"'.format(updated_group.id, updated_group.name))

Node

client.groups.update('11111', {name: 'New group name'})
	.then(group => {
		/* group -> {
			type: 'group',
			id: '11111',
			name: 'New group name',
			created_at: '2014-09-15T13:15:35-07:00',
			modified_at: '2014-09-16T13:15:35-07:00' }
		*/	
	});

iOS

client.groups.update(groupId: "11111", name: "Team A", provenance: .value("Test"), externalSyncIdentifier: .value("Test Sync"), description: .value("Test Description"), invitabilityLevel: .allManagedUsers, memberViewabilityLevel: .allManagedUsers) { 
(result: Result<Group, BoxSDKError>) in
    guard case let .success(group) = result else {
        print("Error updating the group")
        return
    }

    print("Group \(group.name) was updated with description: \(group.description)")

}

レスポンスの例

{
  "id": 11446498,
  "type": "group",
  "created_at": "2012-12-12T10:53:43-08:00",
  "group_type": "managed_group",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "name": "Support"
}