group()

Returns the attributes of a single group by name.

1. Signature

  • Sync

  • Async

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

2. Parameters

Parameter Default Description

name

—

Name of the group.

3. Return value

ECMGroup instance, or None if the group does not exist.

For ECMGroup fields — see groups().

4. Examples

4.1. Load a single group

  • Sync

  • Async

group = ecm.security.group("Administrators")
if group:
    print(group.guid, group.description)
else:
    print("Group not found")
group = await ecm.security.group("Administrators")
if group:
    print(group.guid, group.description)

5. See also