Class: Aws::WorkMail::Types::CreateUserRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkMail::Types::CreateUserRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-workmail/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:display_name, :password, :first_name, :last_name]
Instance Attribute Summary collapse
-
#display_name ⇒ String
The display name for the new user.
-
#first_name ⇒ String
The first name of the new user.
-
#hidden_from_global_address_list ⇒ Boolean
If this parameter is enabled, the user will be hidden from the address book.
-
#last_name ⇒ String
The last name of the new user.
-
#name ⇒ String
The name for the new user.
-
#organization_id ⇒ String
The identifier of the organization for which the user is created.
-
#password ⇒ String
The password for the new user.
-
#role ⇒ String
The role of the new user.
Instance Attribute Details
#display_name ⇒ String
The display name for the new user.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |
#first_name ⇒ String
The first name of the new user.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |
#hidden_from_global_address_list ⇒ Boolean
If this parameter is enabled, the user will be hidden from the address book.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |
#last_name ⇒ String
The last name of the new user.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |
#name ⇒ 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.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |
#organization_id ⇒ String
The identifier of the organization for which the user is created.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |
#password ⇒ String
The password for the new user.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |
#role ⇒ String
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.
712 713 714 715 716 717 718 719 720 721 722 723 |
# File 'lib/aws-sdk-workmail/types.rb', line 712 class CreateUserRequest < Struct.new( :organization_id, :name, :display_name, :password, :role, :first_name, :last_name, :hidden_from_global_address_list) SENSITIVE = [:display_name, :password, :first_name, :last_name] include Aws::Structure end |