Skip to content

AccessControlRule

Source code in docs_src/capo_workmail/types/access_control_rule.py
class AccessControlRule(TypedDict, closed=True):
    name: NotRequired[
        "capo_workmail.types.access_control_rule_name.AccessControlRuleName"
    ]
    """<p>The rule name.</p>"""
    effect: NotRequired[
        "capo_workmail.types.access_control_rule_effect.AccessControlRuleEffect"
    ]
    """<p>The rule effect.</p>"""
    description: NotRequired[
        "capo_workmail.types.access_control_rule_description.AccessControlRuleDescription"
    ]
    """<p>The rule description.</p>"""
    ip_ranges: NotRequired["capo_workmail.types.ip_range_list.IpRangeList"]
    """<p>IPv4 CIDR ranges to include in the rule.</p>"""
    not_ip_ranges: NotRequired["capo_workmail.types.ip_range_list.IpRangeList"]
    """<p>IPv4 CIDR ranges to exclude from the rule.</p>"""
    actions: NotRequired["capo_workmail.types.actions_list.ActionsList"]
    """<p>Access protocol actions to include in the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"""
    not_actions: NotRequired["capo_workmail.types.actions_list.ActionsList"]
    """<p>Access protocol actions to exclude from the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"""
    user_ids: NotRequired["capo_workmail.types.user_id_list.UserIdList"]
    """<p>User IDs to include in the rule.</p>"""
    not_user_ids: NotRequired["capo_workmail.types.user_id_list.UserIdList"]
    """<p>User IDs to exclude from the rule.</p>"""
    date_created: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date that the rule was created.</p>"""
    date_modified: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date that the rule was modified.</p>"""
    impersonation_role_ids: NotRequired[
        "capo_workmail.types.impersonation_role_id_list.ImpersonationRoleIdList"
    ]
    """<p>Impersonation role IDs to include in the rule.</p>"""
    not_impersonation_role_ids: NotRequired[
        "capo_workmail.types.impersonation_role_id_list.ImpersonationRoleIdList"
    ]
    """<p>Impersonation role IDs to exclude from the rule.</p>"""

actions instance-attribute

actions: NotRequired[ActionsList]

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

date_created instance-attribute

date_created: NotRequired[Timestamp]

The date that the rule was created.

date_modified instance-attribute

date_modified: NotRequired[Timestamp]

The date that the rule was modified.

description instance-attribute

description: NotRequired[AccessControlRuleDescription]

The rule description.

effect instance-attribute

effect: NotRequired[AccessControlRuleEffect]

The rule effect.

impersonation_role_ids instance-attribute

impersonation_role_ids: NotRequired[ImpersonationRoleIdList]

Impersonation role IDs to include in the rule.

ip_ranges instance-attribute

ip_ranges: NotRequired[IpRangeList]

IPv4 CIDR ranges to include in the rule.

name instance-attribute

name: NotRequired[AccessControlRuleName]

The rule name.

not_actions instance-attribute

not_actions: NotRequired[ActionsList]

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

not_impersonation_role_ids instance-attribute

not_impersonation_role_ids: NotRequired[ImpersonationRoleIdList]

Impersonation role IDs to exclude from the rule.

not_ip_ranges instance-attribute

not_ip_ranges: NotRequired[IpRangeList]

IPv4 CIDR ranges to exclude from the rule.

not_user_ids instance-attribute

not_user_ids: NotRequired[UserIdList]

User IDs to exclude from the rule.

user_ids instance-attribute

user_ids: NotRequired[UserIdList]

User IDs to include in the rule.