group_members()

Returns all users that are members of the given group.

1. Signature

  • Sync

  • Async

ecm.security.group_members(group_name: str) -> list[ECMUser]
await ecm.security.group_members(group_name: str) -> list[ECMUser]

2. Parameters

Parameter Default Description

group_name

—

Name of the group whose members should be returned.

3. Return value

List of ECMUser instances. Empty list when the group has no members or does not exist.

For ECMUser fields — see users().

4. Examples

4.1. List members of a group

  • Sync

  • Async

members = ecm.security.group_members("Administrators")
for user in members:
    print(user.username, user.display_name)
members = await ecm.security.group_members("Administrators")
for user in members:
    print(user.username, user.display_name)

  • Sync

  • Async

for group in ecm.security.groups():
    members = ecm.security.group_members(group.name)
    print(f"{group.name}: {[m.username for m in members]}")
for group in await ecm.security.groups():
    members = await ecm.security.group_members(group.name)
    print(f"{group.name}: {[m.username for m in members]}")

5. See also