Class: Aws::WorkDocs::Types::User

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

Overview

Describes a user.

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#created_timestampTime

The time when the user was created.

Returns:

  • (Time)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#email_addressString

The email address of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#given_nameString

The given name of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#idString

The ID of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#localeString

The locale of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#modified_timestampTime

The time when the user was modified.

Returns:

  • (Time)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#organization_idString

The ID of the organization.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#recycle_bin_folder_idString

The ID of the recycle bin folder.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#root_folder_idString

The ID of the root folder.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#statusString

The status of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#storageTypes::UserStorageMetadata

The storage for the user.



3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#surnameString

The surname of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#time_zone_idString

The time zone ID of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#typeString

The type of user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end

#usernameString

The login name of the user.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3060

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  SENSITIVE = [:username, :email_address, :given_name, :surname]
  include Aws::Structure
end