UpdateUserRequest ¶

class UpdateUserRequest(TypedDict, closed=True):
    organization_id: "capo_workmail.types.organization_id.OrganizationId"
    """<p>The identifier for the organization under which the user exists.</p>"""
    user_id: "capo_workmail.types.entity_identifier.EntityIdentifier"
    """<p>The identifier for the user to be updated.</p> <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p> <ul> <li> <p>User 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>User name: user</p> </li> </ul>"""
    role: NotRequired["capo_workmail.types.user_role.UserRole"]
    """<p>Updates the user role.</p> <p>You cannot pass <i>SYSTEM_USER</i> or <i>RESOURCE</i>.</p>"""
    display_name: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the display name of the user.</p>"""
    first_name: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's first name.</p>"""
    last_name: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's last name.</p>"""
    hidden_from_global_address_list: NotRequired[
        "capo_workmail.types.boolean_object.BooleanObject"
    ]
    """<p>If enabled, the user is hidden from the global address list.</p>"""
    initials: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's initials.</p>"""
    telephone: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's contact details.</p>"""
    street: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's street address.</p>"""
    job_title: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's job title.</p>"""
    city: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's city.</p>"""
    company: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's company.</p>"""
    zip_code: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's zip code.</p>"""
    department: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's department.</p>"""
    country: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's country.</p>"""
    office: NotRequired["capo_workmail.types.user_attribute.UserAttribute"]
    """<p>Updates the user's office.</p>"""
    identity_provider_user_id: NotRequired[
        "capo_workmail.types.identity_provider_user_id_for_update.IdentityProviderUserIdForUpdate"
    ]
    """<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>"""