User ¶

class User(TypedDict, closed=True):
    user_id: NotRequired["capo_wickr.types.user_id.UserId"]
    """<p>The unique identifier for the user within the network.</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. For bots, this must end in 'bot'.</p>"""
    security_groups: NotRequired[
        "capo_wickr.types.security_group_id_list.SecurityGroupIdList"
    ]
    """<p>A list of security group IDs to which the user is assigned, determining their permissions and feature access.</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 and unable to access the network.</p>"""
    status: NotRequired["int"]
    """<p>The current status of the user (1 for pending invitation, 2 for active).</p>"""
    otp_enabled: NotRequired["bool"]
    """<p>Indicates whether one-time password (OTP) authentication is enabled for the user.</p>"""
    scim_id: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.</p>"""
    type: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The descriptive type of the user account (e.g., 'user').</p>"""
    cell: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The phone number minus country code, used for cloud deployments.</p>"""
    country_code: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The country code for the user's phone number, used for cloud deployments.</p>"""
    challenge_failures: NotRequired["int"]
    """<p>The number of failed password attempts for enterprise deployments, used for account lockout policies.</p>"""
    is_invite_expired: NotRequired["bool"]
    """<p>Indicates whether the user's email invitation code has expired, applicable to cloud deployments.</p>"""
    is_user: NotRequired["bool"]
    """<p>Indicates whether this account is a user (as opposed to a bot or other account type).</p>"""
    invite_code: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The invitation code for this user, used during registration to join the network.</p>"""
    code_validation: NotRequired["bool"]
    """<p>Indicates whether the user can be verified through a custom invite code.</p>"""
    uname: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The unique identifier for the user.</p>"""