delete_group()

Deletes a group from the ECM server.

A group can only be deleted when no users are assigned to it. Empty it first with empty_group().

1. Signature

  • Sync

  • Async

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

2. Parameters

Parameter Default Description

group

—

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

3. Return value

None.

4. Errors

  • ECMException (or subclass) on server failure, e.g. when the group still has members.

5. Examples

5.1. Delete via the group object

  • Sync

  • Async

group = ecm.security.group("Sales")
assert group is not None
ecm.security.empty_group(group)
ecm.security.delete_group(group)
group = await ecm.security.group("Sales")
assert group is not None
await ecm.security.empty_group(group)
await ecm.security.delete_group(group)

5.2. Delete via the group name

ecm.security.empty_group("Sales")
ecm.security.delete_group("Sales")

6. See also