Struct User 

#[non_exhaustive]
pub struct User {

    pub user_id: Option<String>,
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub username: Option<String>,
    pub security_groups: Option<Vec<String>>,
    pub is_admin: Option<bool>,
    pub suspended: Option<bool>,
    pub status: Option<i32>,
    pub otp_enabled: Option<bool>,
    pub scim_id: Option<String>,
    pub type: Option<String>,
    pub cell: Option<String>,
    pub country_code: Option<String>,
    pub challenge_failures: Option<i32>,
    pub is_invite_expired: Option<bool>,
    pub is_user: Option<bool>,
    pub invite_code: Option<String>,
    pub code_validation: Option<bool>,
    pub uname: Option<String>,
}

Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.

codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_id: Option<String>

The unique identifier for the user within the network.

first_name: Option<String>

The first name of the user.

last_name: Option<String>

The last name of the user.

username: Option<String>

The email address or username of the user. For bots, this must end in 'bot'.

security_groups: Option<Vec<String>>

A list of security group IDs to which the user is assigned, determining their permissions and feature access.

is_admin: Option<bool>

Indicates whether the user has administrator privileges in the network.

suspended: Option<bool>

Indicates whether the user is currently suspended and unable to access the network.

status: Option<i32>

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

otp_enabled: Option<bool>

Indicates whether one-time password (OTP) authentication is enabled for the user.

scim_id: Option<String>

The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.

type: Option<String>

The descriptive type of the user account (e.g., 'user').

cell: Option<String>

The phone number minus country code, used for cloud deployments.

country_code: Option<String>

The country code for the user's phone number, used for cloud deployments.

challenge_failures: Option<i32>

The number of failed password attempts for enterprise deployments, used for account lockout policies.

is_invite_expired: Option<bool>

Indicates whether the user's email invitation code has expired, applicable to cloud deployments.

is_user: Option<bool>

Indicates whether this account is a user (as opposed to a bot or other account type).

invite_code: Option<String>

The invitation code for this user, used during registration to join the network.

code_validation: Option<bool>

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

uname: Option<String>

The unique identifier for the user.

Implementations

impl User

pub fn user_id(&self) -> Option<&str>

The unique identifier for the user within the network.

pub fn first_name(&self) -> Option<&str>

The first name of the user.

pub fn last_name(&self) -> Option<&str>

The last name of the user.

pub fn username(&self) -> Option<&str>

The email address or username of the user. For bots, this must end in 'bot'.

pub fn security_groups(&self) -> &[String]

A list of security group IDs to which the user is assigned, determining their permissions and feature access.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_groups.is_none().

pub fn is_admin(&self) -> Option<bool>

Indicates whether the user has administrator privileges in the network.

pub fn suspended(&self) -> Option<bool>

Indicates whether the user is currently suspended and unable to access the network.

pub fn status(&self) -> Option<i32>

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

pub fn otp_enabled(&self) -> Option<bool>

Indicates whether one-time password (OTP) authentication is enabled for the user.

pub fn scim_id(&self) -> Option<&str>

The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.

pub fn type(&self) -> Option<&str>

The descriptive type of the user account (e.g., 'user').

pub fn cell(&self) -> Option<&str>

The phone number minus country code, used for cloud deployments.

pub fn country_code(&self) -> Option<&str>

The country code for the user's phone number, used for cloud deployments.

pub fn challenge_failures(&self) -> Option<i32>

The number of failed password attempts for enterprise deployments, used for account lockout policies.

pub fn is_invite_expired(&self) -> Option<bool>

Indicates whether the user's email invitation code has expired, applicable to cloud deployments.

pub fn is_user(&self) -> Option<bool>

Indicates whether this account is a user (as opposed to a bot or other account type).

pub fn invite_code(&self) -> Option<&str>

The invitation code for this user, used during registration to join the network.

pub fn code_validation(&self) -> Option<bool>

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

pub fn uname(&self) -> Option<&str>

The unique identifier for the user.

impl User

pub fn builder() -> UserBuilder

Creates a new builder-style object to manufacture User.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for User

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for User

fn eq(&self, other: &User) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for User