Class: Aws::WorkMail::Types::User

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::User

Defined in:

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

Overview

The representation of an WorkMail user.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #disabled_date ⇒ Time

  The date indicating when the user was disabled from WorkMail use.

• #display_name ⇒ String

  The display name of the user.

• #email ⇒ String

  The email of the user.

• #enabled_date ⇒ Time

  The date indicating when the user was enabled for WorkMail use.

• #id ⇒ String

  The identifier of the user.

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

• #name ⇒ String

  The name of the user.

• #state ⇒ String

  The state of the user, which can be ENABLED, DISABLED, or DELETED.

• #user_role ⇒ String

  The role of the user.

Instance Attribute Details

#disabled_date ⇒ Time

The date indicating when the user was disabled from WorkMail use.

Returns:

• (Time)

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

class User < Struct.new(
  :id,
  :email,
  :name,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  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 5572

class User < Struct.new(
  :id,
  :email,
  :name,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  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 5572

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

#enabled_date ⇒ Time

The date indicating when the user was enabled for WorkMail use.

Returns:

• (Time)

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

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

#id ⇒ String

The identifier of the user.

Returns:

• (String)

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

class User < Struct.new(
  :id,
  :email,
  :name,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = []
  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 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5572

class User < Struct.new(
  :id,
  :email,
  :name,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date,
  :identity_provider_user_id,
  :identity_provider_identity_store_id)
  SENSITIVE = []
  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 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 5572

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

#name ⇒ String

The name of the user.

Returns:

• (String)

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

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

#state ⇒ String

The state of the user, which can be ENABLED, DISABLED, or DELETED.

Returns:

• (String)

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

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

#user_role ⇒ String

The role of the user.

Returns:

• (String)

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

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