Class: Aws::WorkDocs::Types::CreateUserRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:username, :email_address, :given_name, :surname, :password, :authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#email_address ⇒ String

The email address of the user.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#given_name ⇒ String

The given name of the user.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#organization_id ⇒ String

The ID of the organization.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#password ⇒ String

The password of the user.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#storage_rule ⇒ Types::StorageRuleType

The amount of storage for the user.

Returns:



532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#surname ⇒ String

The surname of the user.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#time_zone_id ⇒ String

The time zone ID of the user.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end

#username ⇒ String

The login name of the user.

Returns:

  • (String) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 532

class CreateUserRequest < Struct.new(
  :organization_id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :password,
  :time_zone_id,
  :storage_rule,
  :authentication_token)
  SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
  include Aws::Structure
end