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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-identitystore/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]

Instance Attribute Summary collapse

Instance Attribute Details

#addresses ⇒ Array<Types::Address>

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

Returns:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  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."

Returns:

  • (String) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#emails ⇒ Array<Types::Email>

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

Returns:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#identity_store_id ⇒ String

The globally unique identifier for the identity store.

Returns:

  • (String) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#locale ⇒ String

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

Returns:

  • (String) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#name ⇒ Types::Name

An object containing the name of the user.

Returns:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#nick_name ⇒ String

A string containing an alternate name for the user.

Returns:

  • (String) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#phone_numbers ⇒ Array<Types::PhoneNumber>

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

Returns:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  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) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#profile_url ⇒ String

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

Returns:

  • (String) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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

#timezone ⇒ String

A string containing the time zone of the user.

Returns:

  • (String) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  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) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  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) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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)
  SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
  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) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 333

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