Class: Aws::Wickr::Types::UpdateUserDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb

Overview

Contains the modifiable details for updating an existing user, including name, password, security group membership, and invitation settings.

A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.

See Also:

Constant Summary collapse

SENSITIVE = 
[:first_name, :last_name]

Instance Attribute Summary collapse

Instance Attribute Details

#code_validation ⇒ Boolean

Indicates whether the user can be verified through a custom invite code.

Returns:

  • (Boolean) 


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3481

class UpdateUserDetails < Struct.new(
  :first_name,
  :last_name,
  :username,
  :security_group_ids,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#first_name ⇒ String

The new first name for the user.

Returns:

  • (String) 


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3481

class UpdateUserDetails < Struct.new(
  :first_name,
  :last_name,
  :username,
  :security_group_ids,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#invite_code ⇒ String

A new custom invite code for the user.

Returns:

  • (String) 


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3481

class UpdateUserDetails < Struct.new(
  :first_name,
  :last_name,
  :username,
  :security_group_ids,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#invite_code_ttl ⇒ Integer

The new time-to-live for the invite code in days.

Returns:

  • (Integer) 


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3481

class UpdateUserDetails < Struct.new(
  :first_name,
  :last_name,
  :username,
  :security_group_ids,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#last_name ⇒ String

The new last name for the user.

Returns:

  • (String) 


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3481

class UpdateUserDetails < Struct.new(
  :first_name,
  :last_name,
  :username,
  :security_group_ids,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The updated list of security group IDs to which the user should belong.

Returns:

  • (Array<String>) 


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3481

class UpdateUserDetails < Struct.new(
  :first_name,
  :last_name,
  :username,
  :security_group_ids,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#username ⇒ String

The new username or email address for the user.

Returns:

  • (String) 


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3481

class UpdateUserDetails < Struct.new(
  :first_name,
  :last_name,
  :username,
  :security_group_ids,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end