Skip to content

User

Source code in docs_src/capo_workdocs/types/user.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class User(TypedDict, closed=True):
    id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the user.</p>"""
    username: NotRequired["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: 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>"""
    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the organization.</p>"""
    root_folder_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
    """<p>The ID of the root folder.</p>"""
    recycle_bin_folder_id: NotRequired[
        "capo_workdocs.types.resource_id_type.ResourceIdType"
    ]
    """<p>The ID of the recycle bin folder.</p>"""
    status: NotRequired["capo_workdocs.types.user_status_type.UserStatusType"]
    """<p>The status of the user.</p>"""
    type: NotRequired["capo_workdocs.types.user_type.UserType"]
    """<p>The type of user.</p>"""
    created_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
    """<p>The time when the user was created.</p>"""
    modified_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
    """<p>The time when the user was modified.</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>"""
    storage: NotRequired[
        "capo_workdocs.types.user_storage_metadata.UserStorageMetadata"
    ]
    """<p>The storage for the user.</p>"""

created_timestamp instance-attribute 

created_timestamp: NotRequired[TimestampType]

The time when the user was created.

email_address instance-attribute 

email_address: NotRequired[EmailAddressType]

The email address of the user.

given_name instance-attribute 

given_name: NotRequired[UserAttributeValueType]

The given name of the user.

id instance-attribute 

id: NotRequired[IdType]

The ID of the user.

locale instance-attribute 

locale: NotRequired[LocaleType]

The locale of the user.

modified_timestamp instance-attribute 

modified_timestamp: NotRequired[TimestampType]

The time when the user was modified.

organization_id instance-attribute 

organization_id: NotRequired[IdType]

The ID of the organization.

recycle_bin_folder_id instance-attribute 

recycle_bin_folder_id: NotRequired[ResourceIdType]

The ID of the recycle bin folder.

root_folder_id instance-attribute 

root_folder_id: NotRequired[ResourceIdType]

The ID of the root folder.

status instance-attribute 

status: NotRequired[UserStatusType]

The status of the user.

storage instance-attribute 

storage: NotRequired[UserStorageMetadata]

The 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 user.

username instance-attribute 

username: NotRequired[UsernameType]

The login name of the user.