Class: Aws::IdentityStore::Types::User

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb

Overview

A user object that contains the metadata and attributes for a specified user.

See Also:

Constant Summary collapse

SENSITIVE = 
[:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]

Instance Attribute Summary collapse

Instance Attribute Details

#addresses ⇒ Array<Types::Address>

A list of Address objects containing addresses associated with the user.

Returns:



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#display_name ⇒ String

A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#emails ⇒ Array<Types::Email>

A list of Email objects containing email addresses associated with the user.

Returns:



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#external_ids ⇒ Array<Types::ExternalId>

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

Returns:



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#identity_store_id ⇒ String

The globally unique identifier for the identity store.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#locale ⇒ String

A string containing the geographical region or location of the user.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#name ⇒ Types::Name

An object containing the name of the user.

Returns:



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#nick_name ⇒ String

A string containing an alternate name for the user.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#phone_numbers ⇒ Array<Types::PhoneNumber>

A list of PhoneNumber objects containing phone numbers associated with the user.

Returns:



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#preferred_language ⇒ String

A string containing the preferred language of the user. For example, "American English" or "en-us."

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#profile_url ⇒ String

A string containing a URL that might be associated with the user.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#timezone ⇒ String

A string containing the time zone of the user.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#title ⇒ String

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#user_id ⇒ String

The identifier for a user in the identity store.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#user_name ⇒ String

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end

#user_type ⇒ String

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

Returns:

  • (String) 


1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1568

class User < Struct.new(
  :user_name,
  :user_id,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :identity_store_id)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  include Aws::Structure
end