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

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::User

Includes:

Structure

Defined in:

lib/aws-sdk-workdocs/types.rb

Overview

Describes a user.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

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

Instance Attribute Summary

• #created_timestamp ⇒ Time

  The time when the user was created.

• #email_address ⇒ String

  The email address of the user.

• #given_name ⇒ String

  The given name of the user.

• #id ⇒ String

  The ID of the user.

• #locale ⇒ String

  The locale of the user.

• #modified_timestamp ⇒ Time

  The time when the user was modified.

• #organization_id ⇒ String

  The ID of the organization.

• #recycle_bin_folder_id ⇒ String

  The ID of the recycle bin folder.

• #root_folder_id ⇒ String

  The ID of the root folder.

• #status ⇒ String

  The status of the user.

• #storage ⇒ Types::UserStorageMetadata

  The storage for the user.

• #surname ⇒ String

  The surname of the user.

• #time_zone_id ⇒ String

  The time zone ID of the user.

• #type ⇒ String

  The type of user.

• #username ⇒ String

  The login name of the user.

Instance Attribute Details

#created_timestamp ⇒ Time

The time when the user was created.

Returns:

• (Time)

# File '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_address ⇒ String

The email address of the user.

Returns:

• (String)

# File '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_name ⇒ String

The given name of the user.

Returns:

• (String)

# File '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

#id ⇒ String

The ID of the user.

Returns:

• (String)

# File '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

#locale ⇒ String

The locale of the user.

Returns:

• (String)

# File '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_timestamp ⇒ Time

The time when the user was modified.

Returns:

• (Time)

# File '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_id ⇒ String

The ID of the organization.

Returns:

• (String)

# File '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_id ⇒ String

The ID of the recycle bin folder.

Returns:

• (String)

# File '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_id ⇒ String

The ID of the root folder.

Returns:

• (String)

# File '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

#status ⇒ String

The status of the user.

Returns:

• (String)

# File '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

#storage ⇒ Types::UserStorageMetadata

The storage for the user.

Returns:

• (Types::UserStorageMetadata)

# File '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

#surname ⇒ String

The surname of the user.

Returns:

• (String)

# File '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_id ⇒ String

The time zone ID of the user.

Returns:

• (String)

# File '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

#type ⇒ String

The type of user.

Returns:

• (String)

# File '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

#username ⇒ String

The login name of the user.

Returns:

• (String)

# File '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