Skip to content

UpdateUserRequest

Source code in docs_src/capo_workdocs/types/update_user_request.py
class UpdateUserRequest(TypedDict, closed=True):
    authentication_token: NotRequired[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ]
    """<p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
    user_id: "capo_workdocs.types.id_type.IdType"
    """<p>The ID of the user.</p>"""
    given_name: NotRequired[
        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
    ]
    """<p>The given name of the user.</p>"""
    surname: NotRequired[
        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
    ]
    """<p>The surname of the user.</p>"""
    type: NotRequired["capo_workdocs.types.user_type.UserType"]
    """<p>The type of the user.</p>"""
    storage_rule: NotRequired["capo_workdocs.types.storage_rule_type.StorageRuleType"]
    """<p>The amount of storage for the user.</p>"""
    time_zone_id: NotRequired["capo_workdocs.types.time_zone_id_type.TimeZoneIdType"]
    """<p>The time zone ID of the user.</p>"""
    locale: NotRequired["capo_workdocs.types.locale_type.LocaleType"]
    """<p>The locale of the user.</p>"""
    grant_poweruser_privileges: NotRequired[
        "capo_workdocs.types.boolean_enum_type.BooleanEnumType"
    ]
    """<p>Boolean value to determine whether the user is granted Power user privileges.</p>"""

authentication_token instance-attribute

authentication_token: NotRequired[AuthenticationHeaderType]

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

given_name instance-attribute

given_name: NotRequired[UserAttributeValueType]

The given name of the user.

grant_poweruser_privileges instance-attribute

grant_poweruser_privileges: NotRequired[BooleanEnumType]

Boolean value to determine whether the user is granted Power user privileges.

locale instance-attribute

locale: NotRequired[LocaleType]

The locale of the user.

storage_rule instance-attribute

storage_rule: NotRequired[StorageRuleType]

The amount of storage for the user.

surname instance-attribute

surname: NotRequired[UserAttributeValueType]

The surname of the user.

time_zone_id instance-attribute

time_zone_id: NotRequired[TimeZoneIdType]

The time zone ID of the user.

type instance-attribute

type: NotRequired[UserType]

The type of the user.

user_id instance-attribute

user_id: IdType

The ID of the user.