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

Class: Aws::WorkMail::Types::DescribeUserResponse

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

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#disabled_date ⇒ Time

The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

Returns:

  • (Time) —

    The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

#display_name ⇒ String

The display name of the user.

Returns:

  • (String) —

    The display name of the user.

#email ⇒ String

The email of the user.

Returns:

  • (String) —

    The email of the user.

#enabled_date ⇒ Time

The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

Returns:

  • (Time) —

    The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

#name ⇒ String

The name for the user.

Returns:

  • (String) —

    The name for the user.

#state ⇒ String

The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

Possible values:

  • ENABLED
  • DISABLED
  • DELETED

Returns:

  • (String) —

    The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

#user_id ⇒ String

The identifier for the described user.

Returns:

  • (String) —

    The identifier for the described user.

#user_role ⇒ String

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

Possible values:

  • USER
  • RESOURCE
  • SYSTEM_USER

Returns:

  • (String) —

    In certain cases, other entities are modeled as users.