Class: Aws::IdentityStore::Types::CreateUserRequest

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>

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

Returns:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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 supports standard date format for storing personal information.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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. This value is typically formatted for display when the user is referenced. For example, “John Doe.” When used in IAM Identity Center, this parameter is required.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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 with additional attribute extensions for the user. Each map key corresponds to an extension name, while map values represent extension data in ‘Document` type (not supported by Java V1, Go V1 and older versions of the CLI). `aws:identitystore:enterprise` is the only supported extension name.

Returns:

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


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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. When used in IAM Identity Center, this parameter is required.

Returns:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.

Returns:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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. ‘Administrator` and `AWSAdministrators` are reserved names and can’t be used for users or groups.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :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 allows users to provide a link to their personal or professional website.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aws-sdk-identitystore/types.rb', line 361

class CreateUserRequest < Struct.new(
  :identity_store_id,
  :user_name,
  :name,
  :display_name,
  :nick_name,
  :profile_url,
  :emails,
  :addresses,
  :phone_numbers,
  :user_type,
  :title,
  :preferred_language,
  :locale,
  :timezone,
  :photos,
  :website,
  :birthdate,
  :extensions)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
  include Aws::Structure
end