ユーザーをグループに追加

post
https://api.box.com/2.0
/group_memberships/

グループメンバーシップを作成します。管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

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

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

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

リクエスト本文

associative array本文内

管理者権限のカスタム設定(グループが受け入れる場合)。このオプションは、ロールがmemberであるメンバーには影響しません。

これらの権限を設定すると、管理者のデフォルトのアクセスレベルが上書きされます。

このオブジェクトの値として"null"を指定すると、設定可能なすべての権限が無効になります。権限を指定すると、それに応じて権限が設定され、省略した権限はデフォルトで有効になります。

boolean本文内省略可能
true

カスタム権限のキーと値のペア。

object本文内

ユーザーを追加するグループ。

string本文内必須
4545523

ユーザーを追加するグループのID

string本文内省略可能
member

グループ内のユーザーのロール。

次の値のいずれか1つ: member,admin

object本文内

グループに追加するユーザー。

string本文内必須
1434325

グループに追加するユーザーのID

レスポンス

新しいグループメンバーシップオブジェクトを返します。

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

post
ユーザーをグループに追加
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/group_memberships" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "user": {
         "id": "1434325"
       },
       "group": {
         "id": "4545523"
       }
     }'

レスポンスの例

{
  "id": 11446498,
  "type": "group_membership",
  "created_at": "2012-12-12T10:53:43-08:00",
  "group": {
    "id": 11446498,
    "type": "group",
    "group_type": "managed_group",
    "name": "Support"
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "role": "member",
  "user": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  }
}