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

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

Overview

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#addresses ⇒ Array<Types::Address>

The physical address of the user.

Returns:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#birthdate ⇒ String

The user’s birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#created_at ⇒ Time

The date and time the user was created.

Returns:

  • (Time) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#created_by ⇒ String

The identifier of the user or system that created the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#emails ⇒ Array<Types::Email>

The email address of the user.

Returns:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  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:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#identity_store_id ⇒ String

The globally unique identifier for the identity store.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#locale ⇒ String

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

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#name ⇒ Types::Name

The name of the user.

Returns:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#nick_name ⇒ String

An alternative descriptive name for the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#phone_numbers ⇒ Array<Types::PhoneNumber>

A list of ‘PhoneNumber` objects associated with a user.

Returns:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#photos ⇒ Array<Types::Photo>

A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.

Returns:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#preferred_language ⇒ String

The preferred language of the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#profile_url ⇒ String

A URL link for the user’s profile.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#timezone ⇒ String

The time zone for a user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#title ⇒ String

A string containing the title of the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the user was last updated.

Returns:

  • (Time) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#updated_by ⇒ String

The identifier of the user or system that last updated the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#user_id ⇒ String

The identifier for a user in the identity store.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  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) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#user_status ⇒ String

The current status of the user account.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#user_type ⇒ String

A string indicating the type of user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#website ⇒ String

The user’s personal website or blog URL. Returns the stored website information for the user.

Returns:

  • (String) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aws-sdk-identitystore/types.rb', line 733

class DescribeUserResponse < Struct.new(
  :identity_store_id,
  :user_id,
  :user_name,
  :external_ids,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :user_status,
  :photos,
  :website,
  :birthdate,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end