Class: Aws::WorkMail::Types::CreateUserRequest

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#display_nameString

The display name for the new user.

Returns:

  • (String)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#first_nameString

The first name of the new user.

Returns:

  • (String)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#hidden_from_global_address_listBoolean

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

Returns:

  • (Boolean)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#identity_provider_user_idString

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)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#last_nameString

The last name of the new user.

Returns:

  • (String)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#organization_idString

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

Returns:

  • (String)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#passwordString

The password for the new user.

Returns:

  • (String)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end

#roleString

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.

Returns:

  • (String)


755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'lib/aws-sdk-workmail/types.rb', line 755

class CreateUserRequest < Struct.new(
  :organization_id,
  :name,
  :display_name,
  :password,
  :role,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :identity_provider_user_id)
  SENSITIVE = [:display_name, :password, :first_name, :last_name]
  include Aws::Structure
end