unassignRole( )
Unassigns a role from group members.
Note: This function is only relevant for site admins, and group members with group admin permissions.
The unassignRole()
function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
Admin Method
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Method Declaration
Copy
Method Parameters
groupIdstringRequired
Group ID.
memberIdsArray<string>Required
Member IDs.
Max: 100 member IDs
roleGroupRoleRequired
Role to unassign.
optionsUnassignRoleOptions
Returns
Return Type:Promise<UnassignRoleResponse>
Was this helpful?
Yes
No