You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateUserRequest data as a hash:

{
  organization_id: "IdType",
  username: "UsernameType", # required
  email_address: "EmailAddressType",
  given_name: "UserAttributeValueType", # required
  surname: "UserAttributeValueType", # required
  password: "PasswordType", # required
  time_zone_id: "TimeZoneIdType",
  storage_rule: {
    storage_allocated_in_bytes: 1,
    storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
  },
  authentication_token: "AuthenticationHeaderType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#email_addressString

The email address of the user.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#given_nameString

The given name of the user.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#organization_idString

The ID of the organization.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#passwordString

The password of the user.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#storage_ruleTypes::StorageRuleType

The amount of storage for the user.



578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#surnameString

The surname of the user.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#time_zone_idString

The time zone ID of the user.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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

#usernameString

The login name of the user.

Returns:

  • (String)


578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 578

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