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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateUserRequest as input to an Aws::Client method, you can use a vanilla 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)

    Amazon WorkDocs authentication token.

#email_addressString

The email address of the user.

Returns:

  • (String)

    The email address of the user.

#given_nameString

The given name of the user.

Returns:

  • (String)

    The given name of the user.

#organization_idString

The ID of the organization.

Returns:

  • (String)

    The ID of the organization.

#passwordString

The password of the user.

Returns:

  • (String)

    The password of the user.

#storage_ruleTypes::StorageRuleType

The amount of storage for the user.

Returns:

#surnameString

The surname of the user.

Returns:

  • (String)

    The surname of the user.

#time_zone_idString

The time zone ID of the user.

Returns:

  • (String)

    The time zone ID of the user.

#usernameString

The login name of the user.

Returns:

  • (String)

    The login name of the user.