empty_group()

Removes all user assignments from a group. The group itself is kept. This is the usual preparation step before delete_group(), because a group can only be deleted when empty.

1. Signature

  • Sync

  • Async

ecm.security.empty_group(group: ECMGroup | str) -> None
await ecm.security.empty_group(group: ECMGroup | str) -> None

2. Parameters

Parameter Default Description

group

—

The group to empty — either an ECMGroup (identified by its GUID) or a group name (str).

3. Return value

None.

4. Errors

  • ECMException (or subclass) on server failure.

5. Examples

  • Sync

  • Async

ecm.security.empty_group("Sales")
assert ecm.security.group_members("Sales") == []
await ecm.security.empty_group("Sales")
assert await ecm.security.group_members("Sales") == []

6. See also