Skip to content

UpdateGroupRequest

Source code in docs_src/capo_workmail/types/update_group_request.py 
15
16
17
18
19
20
21
22
23
class UpdateGroupRequest(TypedDict, closed=True):
    organization_id: "capo_workmail.types.organization_id.OrganizationId"
    """<p>The identifier for the organization under which the group exists.</p>"""
    group_id: "capo_workmail.types.entity_identifier.EntityIdentifier"
    """<p>The identifier for the group to be updated.</p> <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p> <ul> <li> <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Group name: group</p> </li> </ul>"""
    hidden_from_global_address_list: NotRequired[
        "capo_workmail.types.boolean_object.BooleanObject"
    ]
    """<p>If enabled, the group is hidden from the global address list.</p>"""

group_id instance-attribute 

group_id: EntityIdentifier

The identifier for the group to be updated.

The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

  • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: [email protected]

  • Group name: group

hidden_from_global_address_list instance-attribute 

hidden_from_global_address_list: NotRequired[BooleanObject]

If enabled, the group is hidden from the global address list.

organization_id instance-attribute 

organization_id: OrganizationId

The identifier for the organization under which the group exists.