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.

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>

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

Returns:



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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 stores personal birthdate information for the user.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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

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

Prefix search supports a maximum of 1,000 characters for the string.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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>

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

Returns:



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#extensions ⇒ Hash<String,Hash,Array,String,Numeric,Boolean>

A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.

Returns:

  • (Hash<String,Hash,Array,String,Numeric,Boolean>)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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:



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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

An object containing the name of the user.

Returns:



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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

A string containing an alternate name for the user.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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 containing phone numbers associated with the user.

Returns:



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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. Users can have up to 3 photos with metadata including type, display name, and primary designation.

Returns:



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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

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

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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 string containing a URL that might be associated with the user.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#revision ⇒ String

The current revision of the user in the identity store. This value changes each time the user is modified. You can provide it as the Revision parameter of an UpdateUser or DeleteUser request to make the operation conditional on the user not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#roles ⇒ Array<Types::Role>

A list of Role objects containing roles associated with the user.

Returns:



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#timezone ⇒ String

A string containing the time zone of the user.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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. Possible values are left unspecified. The value can vary based on your specific use case.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end

#user_arn ⇒ String

The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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. Possible values are left unspecified. The value can vary based on your specific use case.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  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. This field stores website information for personal or professional use.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 2522

class User < Struct.new(
  :identity_store_id,
  :user_id,
  :user_arn,
  :revision,
  :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,
  :roles,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end