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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]

Instance Attribute Summary

• #city ⇒ String

  City where the user is located.

• #company ⇒ String

  Company of the user.

• #country ⇒ String

  Country where the user is located.

• #department ⇒ String

  Department of the user.

• #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.

• #first_name ⇒ String

  First name of the user.

• #hidden_from_global_address_list ⇒ Boolean

  If enabled, the user is hidden from the global address list.

• #identity_provider_identity_store_id ⇒ String

  Identity Store ID from the IAM Identity Center.

• #identity_provider_user_id ⇒ String

  User ID from the IAM Identity Center.

• #initials ⇒ String

  Initials of the user.

• #job_title ⇒ String

  Job title of the user.

• #last_name ⇒ String

  Last name of the user.

• #mailbox_deprovisioned_date ⇒ Time

  The date when the mailbox was removed for the user.

• #mailbox_provisioned_date ⇒ Time

  The date when the mailbox was created for the user.

• #name ⇒ String

  The name for the user.

• #office ⇒ String

  Office where the user is located.

• #state ⇒ String

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

• #street ⇒ String

  Street where the user is located.

• #telephone ⇒ String

  User’s contact number.

• #user_id ⇒ String

  The identifier for the described user.

• #user_role ⇒ String

  In certain cases, other entities are modeled as users.

• #zip_code ⇒ String

  Zip code of the user.

Instance Attribute Details

#city ⇒ String

City where the user is located.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#company ⇒ String

Company of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#country ⇒ String

Country where the user is located.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#department ⇒ String

Department of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#disabled_date ⇒ Time

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

Returns:

• (Time)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#email ⇒ String

The email of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  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 'lib/aws-sdk-workmail/types.rb', line 1889

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#first_name ⇒ String

First name of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#hidden_from_global_address_list ⇒ Boolean

If enabled, the user is hidden from the global address list.

Returns:

• (Boolean)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#identity_provider_identity_store_id ⇒ String

Identity Store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#identity_provider_user_id ⇒ String

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#initials ⇒ String

Initials of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#job_title ⇒ String

Job title of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#last_name ⇒ String

Last name of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#mailbox_deprovisioned_date ⇒ Time

The date when the mailbox was removed for the user.

Returns:

• (Time)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#mailbox_provisioned_date ⇒ Time

The date when the mailbox was created for the user.

Returns:

• (Time)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#name ⇒ String

The name for the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#office ⇒ String

Office where the user is located.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  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 'lib/aws-sdk-workmail/types.rb', line 1889

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#street ⇒ String

Street where the user is located.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#telephone ⇒ String

User’s contact number.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#user_id ⇒ String

The identifier for the described user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  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, SYSTEM_USER, and REMOTE_USER.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end

#zip_code ⇒ String

Zip code of the user.

Returns:

• (String)

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

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :mailbox_provisioned_date,
  :mailbox_deprovisioned_date,
  :first_name,
  :last_name,
  :hidden_from_global_address_list,
  :initials,
  :telephone,
  :street,
  :job_title,
  :city,
  :company,
  :zip_code,
  :department,
  :country,
  :office,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
  include Aws::Structure
end