Skip to content

GetUserResponse

Source code in docs_src/capo_wickr/types/get_user_response.py
class GetUserResponse(TypedDict, closed=True):
    user_id: "capo_wickr.types.user_id.UserId"
    """<p>The unique identifier of the user.</p>"""
    first_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The first name of the user.</p>"""
    last_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The last name of the user.</p>"""
    username: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The email address or username of the user.</p>"""
    is_admin: NotRequired["bool"]
    """<p>Indicates whether the user has administrator privileges in the network.</p>"""
    suspended: NotRequired["bool"]
    """<p>Indicates whether the user is currently suspended.</p>"""
    status: NotRequired["int"]
    """<p>The current status of the user (1 for pending, 2 for active).</p>"""
    last_activity: NotRequired["int"]
    """<p>The timestamp of the user's last activity in the network, specified in epoch seconds.</p>"""
    last_login: NotRequired["int"]
    """<p>The timestamp of the user's last login to the network, specified in epoch seconds.</p>"""
    security_group_ids: NotRequired[
        "capo_wickr.types.security_group_id_list.SecurityGroupIdList"
    ]
    """<p>A list of security group IDs to which the user belongs.</p>"""

first_name instance-attribute

first_name: NotRequired[SensitiveString]

The first name of the user.

is_admin instance-attribute

is_admin: NotRequired[bool]

Indicates whether the user has administrator privileges in the network.

last_activity instance-attribute

last_activity: NotRequired[int]

The timestamp of the user's last activity in the network, specified in epoch seconds.

last_login instance-attribute

last_login: NotRequired[int]

The timestamp of the user's last login to the network, specified in epoch seconds.

last_name instance-attribute

last_name: NotRequired[SensitiveString]

The last name of the user.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdList]

A list of security group IDs to which the user belongs.

status instance-attribute

status: NotRequired[int]

The current status of the user (1 for pending, 2 for active).

suspended instance-attribute

suspended: NotRequired[bool]

Indicates whether the user is currently suspended.

user_id instance-attribute

user_id: UserId

The unique identifier of the user.

username instance-attribute

username: NotRequired[GenericString]

The email address or username of the user.