Struct CreateUserInput

#[non_exhaustive]
pub struct CreateUserInput {
    pub organization_id: Option<String>,
    pub name: Option<String>,
    pub display_name: Option<String>,
    pub password: Option<String>,
    pub role: Option<UserRole>,
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub hidden_from_global_address_list: Option<bool>,
    pub identity_provider_user_id: Option<String>,
}

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.

organization_id: Option<String>

The identifier of the organization for which the user is created.

name: Option<String>

The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

display_name: Option<String>

The display name for the new user.

password: Option<String>

The password for the new user.

role: Option<UserRole>

The role of the new user.

You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

first_name: Option<String>

The first name of the new user.

last_name: Option<String>

The last name of the new user.

hidden_from_global_address_list: Option<bool>

If this parameter is enabled, the user will be hidden from the address book.

identity_provider_user_id: Option<String>

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Implementations

impl CreateUserInput

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

The identifier of the organization for which the user is created.

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

The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

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

The display name for the new user.

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

The password for the new user.

pub fn role(&self) -> Option<&UserRole>

The role of the new user.

You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

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

The first name of the new user.

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

The last name of the new user.

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

If this parameter is enabled, the user will be hidden from the address book.

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

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

impl CreateUserInput

pub fn builder() -> CreateUserInputBuilder

Creates a new builder-style object to manufacture CreateUserInput.

Trait Implementations

impl Clone for CreateUserInput

fn clone(&self) -> CreateUserInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateUserInput

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

Formats the value using the given formatter.

impl PartialEq for CreateUserInput

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