Skip to content

CreateUserRequest

Source code in docs_src/capo_workdocs/types/create_user_request.py
class CreateUserRequest(TypedDict, closed=True):
    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the organization.</p>"""
    username: "capo_workdocs.types.username_type.UsernameType"
    """<p>The login name of the user.</p>"""
    email_address: NotRequired[
        "capo_workdocs.types.email_address_type.EmailAddressType"
    ]
    """<p>The email address of the user.</p>"""
    given_name: "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
    """<p>The given name of the user.</p>"""
    surname: "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
    """<p>The surname of the user.</p>"""
    password: "capo_workdocs.types.password_type.PasswordType"
    """<p>The password of the user.</p>"""
    time_zone_id: NotRequired["capo_workdocs.types.time_zone_id_type.TimeZoneIdType"]
    """<p>The time zone ID of the user.</p>"""
    storage_rule: NotRequired["capo_workdocs.types.storage_rule_type.StorageRuleType"]
    """<p>The amount of storage for the user.</p>"""
    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>"""

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.

email_address instance-attribute

email_address: NotRequired[EmailAddressType]

The email address of the user.

given_name instance-attribute

The given name of the user.

organization_id instance-attribute

organization_id: NotRequired[IdType]

The ID of the organization.

password instance-attribute

password: PasswordType

The password of the user.

storage_rule instance-attribute

storage_rule: NotRequired[StorageRuleType]

The amount of storage for the user.

surname instance-attribute

The surname of the user.

time_zone_id instance-attribute

time_zone_id: NotRequired[TimeZoneIdType]

The time zone ID of the user.

username instance-attribute

username: UsernameType

The login name of the user.