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

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::DescribeUserResponse

Defined in:

gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #disabled_date ⇒ Time

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

• #display_name ⇒ String

  The display name of the user.

• #email ⇒ String

  The email of the user.

• #enabled_date ⇒ Time

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

• #name ⇒ String

  The name for the user.

• #state ⇒ String

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

• #user_id ⇒ String

  The identifier for the described user.

• #user_role ⇒ String

  In certain cases, other entities are modeled as users.

Instance Attribute Details

#disabled_date ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The display name of the user.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end

#email ⇒ String

The email of the user.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_date ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for the user.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

The identifier for the described user.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end

#user_role ⇒ String

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into 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.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1442

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  include Aws::Structure
end