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

Inherits:

Struct

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

Defined in:

(unknown)

Overview

Describes a user.

Returned by:

• ActivateUserResponse#user
• Comment#contributor
• CommentMetadata#contributor
• CreateUserResponse#user
• GetCurrentUserResponse#user
• Aws::WorkDocs::Types::UpdateUserResponse#user

See Also:

• AWS API Documentation

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) —

  The time when the user was created.

#email_address ⇒ String

The email address of the user.

Returns:

• (String) —

  The email address of the user.

#given_name ⇒ String

The given name of the user.

Returns:

• (String) —

  The given name of the user.

#id ⇒ String

The ID of the user.

Returns:

• (String) —

  The ID of the user.

#locale ⇒ String

The locale of the user.

Possible values:

• en
• fr
• ko
• de
• es
• ja
• ru
• zh_CN
• zh_TW
• pt_BR
• default

Returns:

• (String) —

  The locale of the user.

#modified_timestamp ⇒ Time

The time when the user was modified.

Returns:

• (Time) —

  The time when the user was modified.

#organization_id ⇒ String

The ID of the organization.

Returns:

• (String) —

  The ID of the organization.

#recycle_bin_folder_id ⇒ String

The ID of the recycle bin folder.

Returns:

• (String) —

  The ID of the recycle bin folder.

#root_folder_id ⇒ String

The ID of the root folder.

Returns:

• (String) —

  The ID of the root folder.

#status ⇒ String

The status of the user.

Possible values:

• ACTIVE
• INACTIVE
• PENDING

Returns:

• (String) —

  The status of the user.

#storage ⇒ Types::UserStorageMetadata

The storage for the user.

Returns:

• (Types::UserStorageMetadata) —

  The storage for the user.

#surname ⇒ String

The surname of the user.

Returns:

• (String) —

  The surname of the user.

#time_zone_id ⇒ String

The time zone ID of the user.

Returns:

• (String) —

  The time zone ID of the user.

#type ⇒ String

The type of user.

Possible values:

• USER
• ADMIN
• POWERUSER
• MINIMALUSER
• WORKSPACESUSER

Returns:

• (String) —

  The type of user.

#username ⇒ String

The login name of the user.

Returns:

• (String) —

  The login name of the user.