グループを更新
特定のグループを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。
リクエスト
パスパラメータ
57645グループのID。
クエリパラメータ
id,type,name応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
リクエスト本文
"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 Directory255Active DirectoryやOktaなど、このグループの元になっている外部ソースを追跡します。
また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。
これはグループを一方向にのみ同期する場合に適しています。
レスポンス
更新されたグループオブジェクトを返します。
競合が原因でグループを作成できないことを示すエラーを返します。
invalid_parameter: グループ名が会社内で一意でない場合によく返されます。
予期しないクライアントエラー。
リクエストの例
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"
}'レスポンスの例
{
"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"
}