Skip to content

User

Source code in docs_src/capo_workmail/types/user.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class User(TypedDict, closed=True):
    id: NotRequired["capo_workmail.types.work_mail_identifier.WorkMailIdentifier"]
    """<p>The identifier of the user.</p>"""
    email: NotRequired["capo_workmail.types.email_address.EmailAddress"]
    """<p>The email of the user.</p>"""
    name: NotRequired["capo_workmail.types.user_name.UserName"]
    """<p>The name of the user.</p>"""
    display_name: NotRequired["capo_workmail.types.string.String"]
    """<p>The display name of the user.</p>"""
    state: NotRequired["capo_workmail.types.entity_state.EntityState"]
    """<p>The state of the user, which can be ENABLED, DISABLED, or DELETED.</p>"""
    user_role: NotRequired["capo_workmail.types.user_role.UserRole"]
    """<p>The role of the user.</p>"""
    enabled_date: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date indicating when the user was enabled for WorkMail use.</p>"""
    disabled_date: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date indicating when the user was disabled from WorkMail use.</p>"""
    identity_provider_user_id: NotRequired[
        "capo_workmail.types.identity_provider_user_id.IdentityProviderUserId"
    ]
    """<p>User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p>"""
    identity_provider_identity_store_id: NotRequired[
        "capo_workmail.types.identity_provider_identity_store_id.IdentityProviderIdentityStoreId"
    ]
    """<p>Identity store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p>"""

disabled_date instance-attribute 

disabled_date: NotRequired[Timestamp]

The date indicating when the user was disabled from WorkMail use.

display_name instance-attribute 

display_name: NotRequired[String]

The display name of the user.

email instance-attribute 

email: NotRequired[EmailAddress]

The email of the user.

enabled_date instance-attribute 

enabled_date: NotRequired[Timestamp]

The date indicating when the user was enabled for WorkMail use.

id instance-attribute 

id: NotRequired[WorkMailIdentifier]

The identifier of the user.

identity_provider_identity_store_id instance-attribute 

identity_provider_identity_store_id: NotRequired[IdentityProviderIdentityStoreId]

Identity store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

identity_provider_user_id instance-attribute 

identity_provider_user_id: NotRequired[IdentityProviderUserId]

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

name instance-attribute 

name: NotRequired[UserName]

The name of the user.

state instance-attribute 

state: NotRequired[EntityState]

The state of the user, which can be ENABLED, DISABLED, or DELETED.

user_role instance-attribute 

user_role: NotRequired[UserRole]

The role of the user.