Class: Aws::Connect::Types::UserIdentityInfo

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::UserIdentityInfo

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

Contains information about the identity of a user.

<note markdown=“1”> For Amazon Connect instances that are created with the ‘EXISTING_DIRECTORY` identity management type, `FirstName`, `LastName`, and `Email` cannot be updated from within Amazon Connect because they are managed by the directory.

</note>

The ‘FirstName` and `LastName` length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for `FirstName`, and 1-256 for `LastName`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:first_name, :last_name, :email, :secondary_email]

Instance Attribute Summary

• #email ⇒ String

  The email address.

• #first_name ⇒ String

  The first name.

• #last_name ⇒ String

  The last name.

• #mobile ⇒ String

  The user’s mobile number.

• #secondary_email ⇒ String

  The user’s secondary email address.

Instance Attribute Details

#email ⇒ String

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 23655

class UserIdentityInfo < Struct.new(
  :first_name,
  :last_name,
  :email,
  :secondary_email,
  :mobile)
  SENSITIVE = [:first_name, :last_name, :email, :secondary_email]
  include Aws::Structure
end

#first_name ⇒ String

The first name. This is required if you are using Amazon Connect or SAML for identity management.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 23655

class UserIdentityInfo < Struct.new(
  :first_name,
  :last_name,
  :email,
  :secondary_email,
  :mobile)
  SENSITIVE = [:first_name, :last_name, :email, :secondary_email]
  include Aws::Structure
end

#last_name ⇒ String

The last name. This is required if you are using Amazon Connect or SAML for identity management.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 23655

class UserIdentityInfo < Struct.new(
  :first_name,
  :last_name,
  :email,
  :secondary_email,
  :mobile)
  SENSITIVE = [:first_name, :last_name, :email, :secondary_email]
  include Aws::Structure
end

#mobile ⇒ String

The user’s mobile number.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 23655

class UserIdentityInfo < Struct.new(
  :first_name,
  :last_name,
  :email,
  :secondary_email,
  :mobile)
  SENSITIVE = [:first_name, :last_name, :email, :secondary_email]
  include Aws::Structure
end

#secondary_email ⇒ String

The user’s secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

Pattern: ‘(?=^.0,265$)[a-zA-Z0-9._%-]@+.[a-zA-Z]2,63`

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 23655

class UserIdentityInfo < Struct.new(
  :first_name,
  :last_name,
  :email,
  :secondary_email,
  :mobile)
  SENSITIVE = [:first_name, :last_name, :email, :secondary_email]
  include Aws::Structure
end