Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
434534
The ID of the group membership.
id,type,name
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
Custom configuration for the permissions an admin
if a group will receive. This option has no effect
on members with a role of member
.
Setting these permissions overwrites the default access levels of an admin.
Specifying a value of null
for this object will disable
all configurable permissions. Specifying permissions will set
them accordingly, omitted permissions will be enabled by default.
true
A key value pair of custom permissions.
"member"
The role of the user in the group.
Value is one of member
,admin
Returns a new group membership object.
An unexpected client error.
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"
}'
await client.memberships.updateGroupMembershipById(groupMembership.id!, {
requestBody: {
role: 'admin' as UpdateGroupMembershipByIdRequestBodyRoleField,
} satisfies UpdateGroupMembershipByIdRequestBody,
} satisfies UpdateGroupMembershipByIdOptionalsInput);
client.memberships.update_group_membership_by_id(
group_membership.id, role=UpdateGroupMembershipByIdRole.ADMIN.value
)
await client.Memberships.UpdateGroupMembershipByIdAsync(groupMembershipId: NullableUtils.Unwrap(groupMembership.Id), requestBody: new UpdateGroupMembershipByIdRequestBody() { Role = UpdateGroupMembershipByIdRequestBodyRoleField.Admin });
try await client.memberships.updateGroupMembershipById(groupMembershipId: groupMembership.id!, requestBody: UpdateGroupMembershipByIdRequestBody(role: UpdateGroupMembershipByIdRequestBodyRoleField.admin))
BoxGroupMembership membership = new BoxGroupMembership(api, id);
BoxGroupMembership.Info info = membership.new Info();
info.setGroupRole(BoxGroupMembership.GroupRole.MEMBER);
membership.updateInfo(info);
membership_id = '1234'
membership_update = {'role': 'admin'}
updated_membership = client.group_membership(membership_id).update_info(data=membership_update)
print(f'Updated {updated_membership.user.name}\'s group role to {updated_membership.role}')
var updates = new BoxGroupMembershipRequest()
{
Role = "admin"
};
BoxGroupMembership updatedMembership = await client.GroupsManager
.UpdateGroupMembershipAsync("33333", updates);
// Promote a user to group admin
client.groups.updateMembership('12345', {role: client.groups.userRoles.ADMIN})
.then(membership => {
/* membership -> {
type: 'group_membership',
id: '33333',
user:
{ type: 'user',
id: '22222',
name: 'Alison Wonderland',
login: 'alice@example.com' },
group: { type: 'group', id: '11111', name: 'Employees' },
role: 'admin',
configurable_permissions:
{ can_run_reports: false,
can_instant_login: false,
can_create_accounts: false,
can_edit_accounts: false },
created_at: '2013-05-16T15:27:57-07:00',
modified_at: '2013-05-16T15:27:57-07:00' }
*/
});
client.groups.updateMembership(membershipId: "12345", role: .admin, configurablePermission: .value(ConfigurablePermissionData(canRunReports: true, canInstantLogin: true, canCreateAccounts: false, canEditAccounts: true))) {
(result: Result<GroupMembership, BoxSDKError>) in
guard case let .success(membership) = result else {
print("Error updating group membership")
return
}
print("Group membership with ID \(membership.id) was updated")
}
{
"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"
}
}