add_user_to_group()

Adds a user to a group. Inserts a row into the database table bgrel.

1. Signature

  • Sync

  • Async

ecm.security.add_user_to_group(user_guid: str, group_guid: str) -> None
await ecm.security.add_user_to_group(user_guid: str, group_guid: str) -> None

2. Parameters

Parameter Default Description

user_guid

—

GUID of the user.

group_guid

—

GUID of the group.

3. Return value

None.

4. Errors

  • ECMException (or subclass) on server failures.

5. Examples

5.1. Add a user to the "STANDARD" group

  • Sync

  • Async

user = ecm.security.user("john")
group = ecm.security.group("STANDARD")
assert user and group
ecm.security.add_user_to_group(user.guid, group.guid)
user = await ecm.security.user("john")
group = await ecm.security.group("STANDARD")
assert user and group
await ecm.security.add_user_to_group(user.guid, group.guid)

5.2. Add to multiple groups in one go

user = ecm.security.user("john")
for group_name in ("STANDARD", "AUDITORS"):
    g = ecm.security.group(group_name)
    if g:
        ecm.security.add_user_to_group(user.guid, g.guid)

6. See also