Struct BatchCreateUserRequestItem 

#[non_exhaustive]
pub struct BatchCreateUserRequestItem {
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub security_group_ids: Vec<String>,
    pub username: String,
    pub invite_code: Option<String>,
    pub invite_code_ttl: Option<i32>,
    pub code_validation: Option<bool>,
}

Contains the details for a single user to be created in a batch user creation request.

A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.

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.

first_name: Option<String>

The first name of the user.

last_name: Option<String>

The last name of the user.

security_group_ids: Vec<String>

A list of security group IDs to which the user should be assigned.

username: String

The email address or username for the user. Must be unique within the network.

invite_code: Option<String>

A custom invite code for the user. If not provided, one will be generated automatically.

invite_code_ttl: Option<i32>

The time-to-live for the invite code in days. After this period, the invite code will expire.

code_validation: Option<bool>

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

Implementations

impl BatchCreateUserRequestItem

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 security_group_ids(&self) -> &[String]

A list of security group IDs to which the user should be assigned.

pub fn username(&self) -> &str

The email address or username for the user. Must be unique within the network.

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

A custom invite code for the user. If not provided, one will be generated automatically.

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

The time-to-live for the invite code in days. After this period, the invite code will expire.

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

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

impl BatchCreateUserRequestItem

pub fn builder() -> BatchCreateUserRequestItemBuilder

Creates a new builder-style object to manufacture BatchCreateUserRequestItem.

Trait Implementations

impl Clone for BatchCreateUserRequestItem

fn clone(&self) -> BatchCreateUserRequestItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchCreateUserRequestItem

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

Formats the value using the given formatter.

impl PartialEq for BatchCreateUserRequestItem

fn eq(&self, other: &BatchCreateUserRequestItem) -> 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 BatchCreateUserRequestItem