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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-workmail/types.rb

Overview

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#city ⇒ String

Updates the user’s city.

Returns:

  • (String) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#identity_provider_user_id ⇒ 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.

Returns:

  • (String) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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: [email protected]

  • User name: user

Returns:

  • (String) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  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 zip code.

Returns:

  • (String) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/aws-sdk-workmail/types.rb', line 5496

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,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end