Box Developerドキュメント
 
    最新バージョン

    グループを更新

    put
    https://api.box.com/2.0
    /groups/:group_id

    このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

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

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    パスパラメータ

    stringパス内必須
    57645

    グループのID。

    クエリパラメータ

    string arrayクエリ内省略可能
    id,type,name

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

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

    リクエスト本文

    string本文内省略可能
    ""Customer Support Group - as imported from Active Directory""
    255

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

    string本文内省略可能
    "AD:123456"

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

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

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

    string本文内省略可能
    "admins_only"

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

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

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

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

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

    string本文内省略可能
    "admins_only"

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

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

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

    string本文内省略可能
    "Customer Support"

    作成する新しいグループの名前。企業内で一意である必要があります。

    string本文内省略可能
    "Active Directory"
    255

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

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

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

    レスポンス

    application/jsonグループ (Full)

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

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

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

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

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

    レスポンスの例

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