Struct UpdateUserInput

#[non_exhaustive]
pub struct UpdateUserInput {

    pub organization_id: Option<String>,
    pub user_id: Option<String>,
    pub role: Option<UserRole>,
    pub display_name: Option<String>,
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub hidden_from_global_address_list: Option<bool>,
    pub initials: Option<String>,
    pub telephone: Option<String>,
    pub street: Option<String>,
    pub job_title: Option<String>,
    pub city: Option<String>,
    pub company: Option<String>,
    pub zip_code: Option<String>,
    pub department: Option<String>,
    pub country: Option<String>,
    pub office: Option<String>,
    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 for the organization under which the user exists.

user_id: Option<String>

The identifier for the user to be updated.

The identifier can be the UserId, Username, or email. The following identity formats are available:

• User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: user@domain.tld

• User name: user

role: Option<UserRole>

Updates the user role.

You cannot pass SYSTEM_USER or RESOURCE.

display_name: Option<String>

Updates the display name of the user.

first_name: Option<String>

Updates the user's first name.

last_name: Option<String>

Updates the user's last name.

hidden_from_global_address_list: Option<bool>

If enabled, the user is hidden from the global address list.

initials: Option<String>

Updates the user's initials.

telephone: Option<String>

Updates the user's contact details.

street: Option<String>

Updates the user's street address.

job_title: Option<String>

Updates the user's job title.

city: Option<String>

Updates the user's city.

company: Option<String>

Updates the user's company.

zip_code: Option<String>

Updates the user's zip code.

department: Option<String>

Updates the user's department.

country: Option<String>

Updates the user's country.

office: Option<String>

Updates the user's office.

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 UpdateUserInput

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

The identifier for the organization under which the user exists.

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

The identifier for the user to be updated.

The identifier can be the UserId, Username, or email. The following identity formats are available:

• User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: user@domain.tld

• User name: user

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

Updates the user role.

You cannot pass SYSTEM_USER or RESOURCE.

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

Updates the display name of the user.

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

Updates the user's first name.

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

Updates the user's last name.

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

If enabled, the user is hidden from the global address list.

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

Updates the user's initials.

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

Updates the user's contact details.

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

Updates the user's street address.

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

Updates the user's job title.

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

Updates the user's city.

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

Updates the user's company.

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

Updates the user's zip code.

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

Updates the user's department.

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

Updates the user's country.

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

Updates the user's office.

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 UpdateUserInput

pub fn builder() -> UpdateUserInputBuilder

Creates a new builder-style object to manufacture UpdateUserInput.

Trait Implementations

impl Clone for UpdateUserInput

fn clone(&self) -> UpdateUserInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateUserInput

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