Skip to content

ImpersonationRule

Source code in docs_src/capo_workmail/types/impersonation_rule.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ImpersonationRule(TypedDict, closed=True):
    impersonation_rule_id: (
        "capo_workmail.types.impersonation_rule_id.ImpersonationRuleId"
    )
    """<p>The identifier of the rule.</p>"""
    name: NotRequired[
        "capo_workmail.types.impersonation_rule_name.ImpersonationRuleName"
    ]
    """<p>The rule name.</p>"""
    description: NotRequired[
        "capo_workmail.types.impersonation_rule_description.ImpersonationRuleDescription"
    ]
    """<p>The rule description.</p>"""
    effect: "capo_workmail.types.access_effect.AccessEffect"
    """<p>The effect of the rule when it matches the input. Allowed effect values are <code>ALLOW</code> or <code>DENY</code>.</p>"""
    target_users: NotRequired["capo_workmail.types.target_users.TargetUsers"]
    """<p>A list of user IDs that match the rule.</p>"""
    not_target_users: NotRequired["capo_workmail.types.target_users.TargetUsers"]
    """<p>A list of user IDs that don't match the rule.</p>"""

description instance-attribute 

description: NotRequired[ImpersonationRuleDescription]

The rule description.

effect instance-attribute 

effect: AccessEffect

The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.

impersonation_rule_id instance-attribute 

impersonation_rule_id: ImpersonationRuleId

The identifier of the rule.

name instance-attribute 

name: NotRequired[ImpersonationRuleName]

The rule name.

not_target_users instance-attribute 

not_target_users: NotRequired[TargetUsers]

A list of user IDs that don't match the rule.

target_users instance-attribute 

target_users: NotRequired[TargetUsers]

A list of user IDs that match the rule.