グループメンバーシップを作成します。管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。
id,type,name
レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
管理者権限のカスタム設定 (グループが受け入れる場合)。このオプションは、ロールがmember
であるメンバーには影響しません。
これらの権限を設定すると、管理者のデフォルトのアクセスレベルが上書きされます。
このオブジェクトの値としてnull
を指定すると、設定可能なすべての権限が無効になります。権限を指定すると、それに応じて権限が設定され、省略した権限はデフォルトで有効になります。
true
カスタム権限のキーと値のペア。
ユーザーを追加するグループ。
"4545523"
ユーザーを追加するグループのID
"member"
グループ内のユーザーのロール。
次の値のいずれか1つ: member
,admin
グループに追加するユーザー。
"1434325"
グループに追加するユーザーのID
新しいグループメンバーシップオブジェクトを返します。
ユーザーをグループに追加できない場合にエラーを返します。
forbidden_by_policy
: 情報バリアの制限によりグループへのユーザーの追加が禁止されています。予期しないクライアントエラー。
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"
}
}