Class: Aws::IdentityStore::Types::DescribeUserResponse

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

Overview

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

#addressesArray<Types::Address>

The physical address of the user.

Returns:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_nameString

The display name of the user.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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

#emailsArray<Types::Email>

The email address of the user.

Returns:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_idsArray<Types::ExternalId>

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

Returns:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_idString

The globally unique identifier for the identity store.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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

#localeString

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

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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

#nameTypes::Name

The name of the user.

Returns:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_nameString

An alternative descriptive name for the user.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_numbersArray<Types::PhoneNumber>

A list of PhoneNumber objects associated with a user.

Returns:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_languageString

The preferred language of the user.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_urlString

A URL link for the user's profile.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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

#timezoneString

The time zone for a user.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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

#titleString

A string containing the title of the user.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_idString

The identifier for a user in the identity store.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_nameString

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)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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_typeString

A string indicating the type of user.

Returns:

  • (String)


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 627

class DescribeUserResponse < 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