update_group()

Sets the attributes of an existing group. The group is identified by its id / guid; name, profile_user_id and description are written.

Because ECMGroup is a frozen dataclass, you typically pass a modified copy via dataclasses.replace.

1. Signature

  • Sync

  • Async

ecm.security.update_group(group: ECMGroup) -> None
await ecm.security.update_group(group: ECMGroup) -> None

2. Parameters

Parameter Default Description

group

—

The group to update. Carries id / guid for identification plus the target values name, profile_user_id and description.

3. Return value

None.

4. Errors

  • ECMException (or subclass) on server failure.

5. Examples

5.1. Change the description

  • Sync

  • Async

import dataclasses

group = ecm.security.group("Sales")
assert group is not None
ecm.security.update_group(dataclasses.replace(group, description="Sales EMEA"))
import dataclasses

group = await ecm.security.group("Sales")
assert group is not None
await ecm.security.update_group(dataclasses.replace(group, description="Sales EMEA"))

6. See also