Skip to content

UpdateUserResponse

Source code in docs_src/capo_wickr/types/update_user_response.py
class UpdateUserResponse(TypedDict, closed=True):
    user_id: "capo_wickr.types.user_id.UserId"
    """<p>The unique identifier of the updated user.</p>"""
    network_id: "capo_wickr.types.network_id.NetworkId"
    """<p>The ID of the network where the user was updated.</p>"""
    security_group_ids: NotRequired[
        "capo_wickr.types.security_group_id_list.SecurityGroupIdList"
    ]
    """<p>The list of security group IDs to which the user now belongs after the update.</p>"""
    first_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The updated first name of the user.</p>"""
    last_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The updated last name of the user.</p>"""
    middle_name: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The middle name of the user (currently not used).</p>"""
    suspended: "bool"
    """<p>Indicates whether the user is suspended after the update.</p>"""
    modified: NotRequired["int"]
    """<p>The timestamp when the user was last modified, specified in epoch seconds.</p>"""
    status: NotRequired["int"]
    """<p>The user's status after the update.</p>"""
    invite_code: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The updated invite code for the user, if applicable.</p>"""
    invite_expiration: NotRequired["int"]
    """<p>The expiration time of the user's invite code, specified in epoch seconds.</p>"""
    code_validation: NotRequired["bool"]
    """<p>Indicates whether the user can be verified through a custom invite code.</p>"""

code_validation instance-attribute

code_validation: NotRequired[bool]

Indicates whether the user can be verified through a custom invite code.

first_name instance-attribute

first_name: NotRequired[SensitiveString]

The updated first name of the user.

invite_code instance-attribute

invite_code: NotRequired[GenericString]

The updated invite code for the user, if applicable.

invite_expiration instance-attribute

invite_expiration: NotRequired[int]

The expiration time of the user's invite code, specified in epoch seconds.

last_name instance-attribute

last_name: NotRequired[SensitiveString]

The updated last name of the user.

middle_name instance-attribute

middle_name: NotRequired[GenericString]

The middle name of the user (currently not used).

modified instance-attribute

modified: NotRequired[int]

The timestamp when the user was last modified, specified in epoch seconds.

network_id instance-attribute

network_id: NetworkId

The ID of the network where the user was updated.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdList]

The list of security group IDs to which the user now belongs after the update.

status instance-attribute

status: NotRequired[int]

The user's status after the update.

suspended instance-attribute

suspended: bool

Indicates whether the user is suspended after the update.

user_id instance-attribute

user_id: UserId

The unique identifier of the updated user.