Groups.deleteMembers (Method)
Deletes one or more members (users and groups) from a group.
Returns:
MultipleOperationResult (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| otherError | NonNegativeInteger | The number of items whose operation failed for non-security reasons. |
| securityError | NonNegativeInteger | The number of items whose operation failed because of security restrictions. |
| success | NonNegativeInteger | The number of items where the operation was successful. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| groupID | GroupID_Deletable_NonVisitorContext | Required | A group's ID. |
| userGroupIDList | UserGroupIDorOrphanList | Required | A comma-delimited list of user and group IDs. |
Context:
| License Requirements | None |
| Permission Requirements | Group:Admin |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 24008 | You cannot remove members from a group because you are not an administrator for the group. |
| 24009 | UserGroupID $1 is not a member of the group whose ID is $2. |
Notes:
None