Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
最新バージョン
グループメンバーシップを更新
APIバージョン 2024.0
ユーザーのグループメンバーシップを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
434534グループメンバーシップのID。
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
リクエスト本文
associative array本文内
管理者権限のカスタム設定 (グループが受け入れる場合)。このオプションは、ロールがmemberであるメンバーには影響しません。
これらの権限を設定すると、管理者のデフォルトのアクセスレベルが上書きされます。
このオブジェクトの値としてnullを指定すると、設定可能なすべての権限が無効になります 。権限を指定すると、それに応じて権限が設定され、省略した権限はデフォルトで有効になります。
boolean本文内省略可能
trueカスタム権限のキーと値のペア。
string本文内省略可能
"member"グループ内のユーザーのロール。
次の値のいずれか1つ: member,admin
レスポンス
application/jsonグループメンバーシップ
新しいグループメンバーシップオブジェクトを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X PUT "https://api.box.com/2.0/group_memberships/434534" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"role": "admin"
}'Node/TypeScript v10
await client.memberships.updateGroupMembershipById(groupMembership.id!, {
requestBody: {
role: 'admin' as UpdateGroupMembershipByIdRequestBodyRoleField,
} satisfies UpdateGroupMembershipByIdRequestBody,
} satisfies UpdateGroupMembershipByIdOptionalsInput);Python v10
client.memberships.update_group_membership_by_id(
group_membership.id, role=UpdateGroupMembershipByIdRole.ADMIN
).NET v10
await client.Memberships.UpdateGroupMembershipByIdAsync(groupMembershipId: NullableUtils.Unwrap(groupMembership.Id), requestBody: new UpdateGroupMembershipByIdRequestBody() { Role = UpdateGroupMembershipByIdRequestBodyRoleField.Admin });Swift v10
try await client.memberships.updateGroupMembershipById(groupMembershipId: groupMembership.id!, requestBody: UpdateGroupMembershipByIdRequestBody(role: UpdateGroupMembershipByIdRequestBodyRoleField.admin))Java v10
client.getMemberships().updateGroupMembershipById(groupMembership.getId(), new UpdateGroupMembershipByIdRequestBody.Builder().role(UpdateGroupMembershipByIdRequestBodyRoleField.ADMIN).build()).NET v6
await client.Memberships.UpdateGroupMembershipByIdAsync(groupMembershipId: NullableUtils.Unwrap(groupMembership.Id), requestBody: new UpdateGroupMembershipByIdRequestBody() { Role = UpdateGroupMembershipByIdRequestBodyRoleField.Admin });Node v4
await client.memberships.updateGroupMembershipById(groupMembership.id!, {
requestBody: {
role: 'admin' as UpdateGroupMembershipByIdRequestBodyRoleField,
} satisfies UpdateGroupMembershipByIdRequestBody,
} satisfies UpdateGroupMembershipByIdOptionalsInput);レスポンスの例
{
"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"
}
}