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.

Method Declaration
Copy
Method Parameters
identifiersIdentifiersRequired

Group ID and member IDs.

rolestringRequired

Group member role to unassign.

  • "ADMIN": Group admin.
optionsOptions

Authorization options.

Returns
Return Type:Promise<Role>
Was this helpful?
Yes
No