Class: Aws::WorkMail::Types::UpdateUserRequest

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::UpdateUserRequest

Defined in:

gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]

Instance Attribute Summary

• #city ⇒ String

  Updates the user's city.

• #company ⇒ String

  Updates the user's company.

• #country ⇒ String

  Updates the user's country.

• #department ⇒ String

  Updates the user's department.

• #display_name ⇒ String

  Updates the display name of the user.

• #first_name ⇒ String

  Updates the user's first name.

• #hidden_from_global_address_list ⇒ Boolean

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

• #initials ⇒ String

  Updates the user's initials.

• #job_title ⇒ String

  Updates the user's job title.

• #last_name ⇒ String

  Updates the user's last name.

• #office ⇒ String

  Updates the user's office.

• #organization_id ⇒ String

  The identifier for the organization under which the user exists.

• #role ⇒ String

  Updates the user role.

• #street ⇒ String

  Updates the user's street address.

• #telephone ⇒ String

  Updates the user's contact details.

• #user_id ⇒ String

  The identifier for the user to be updated.

• #zip_code ⇒ String

  Updates the user's zipcode.

Instance Attribute Details

#city ⇒ String

Updates the user's city.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#company ⇒ String

Updates the user's company.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#country ⇒ String

Updates the user's country.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#department ⇒ String

Updates the user's department.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#display_name ⇒ String

Updates the display name of the user.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#first_name ⇒ String

Updates the user's first name.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#hidden_from_global_address_list ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#initials ⇒ String

Updates the user's initials.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#job_title ⇒ String

Updates the user's job title.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#last_name ⇒ String

Updates the user's last name.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#office ⇒ String

Updates the user's office.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#organization_id ⇒ String

The identifier for the organization under which the user exists.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#role ⇒ String

Updates the user role.

You cannot pass SYSTEM_USER or RESOURCE.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#street ⇒ String

Updates the user's street address.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#telephone ⇒ String

Updates the user's contact details.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#user_id ⇒ 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

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#zip_code ⇒ String

Updates the user's zipcode.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5100

class UpdateUserRequest < Struct.new(
  :organization_id,
  :user_id,
  :role,
  :display_name,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end