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

Inherits:

Struct

• Object
• Struct
• Aws::IdentityStore::Types::User

Includes:

Structure

Defined in:

lib/aws-sdk-identitystore/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

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

Instance Attribute Summary

• #addresses ⇒ Array<Types::Address>

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

• #birthdate ⇒ String

  The user’s birthdate in YYYY-MM-DD format.

• #created_at ⇒ Time

  The date and time the user was created.

• #created_by ⇒ String

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

• #display_name ⇒ String

  A string containing the name of the user that is formatted for display when the user is referenced.

• #emails ⇒ Array<Types::Email>

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

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

  A map of explicitly requested attribute extensions associated with the user.

• #external_ids ⇒ Array<Types::ExternalId>

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

• #identity_store_id ⇒ String

  The globally unique identifier for the identity store.

• #locale ⇒ String

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

• #name ⇒ Types::Name

  An object containing the name of the user.

• #nick_name ⇒ String

  A string containing an alternate name for the user.

• #phone_numbers ⇒ Array<Types::PhoneNumber>

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

• #photos ⇒ Array<Types::Photo>

  A list of photos associated with the user.

• #preferred_language ⇒ String

  A string containing the preferred language of the user.

• #profile_url ⇒ String

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

• #timezone ⇒ String

  A string containing the time zone of the user.

• #title ⇒ String

  A string containing the title of the user.

• #updated_at ⇒ Time

  The date and time the user was last updated.

• #updated_by ⇒ String

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

• #user_id ⇒ String

  The identifier for a user in the identity store.

• #user_name ⇒ String

  A unique string used to identify the user.

• #user_status ⇒ String

  The current status of the user account.

• #user_type ⇒ String

  A string indicating the type of user.

• #website ⇒ String

  The user’s personal website or blog URL.

Instance Attribute Details

#addresses ⇒ Array<Types::Address>

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

Returns:

• (Array<Types::Address>)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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:

• (Array<Types::Email>)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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>)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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:

• (Array<Types::ExternalId>)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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:

• (Types::Name)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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:

• (Array<Types::PhoneNumber>)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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:

• (Array<Types::Photo>)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :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)

# File 'lib/aws-sdk-identitystore/types.rb', line 1854

class User < 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,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end