Class: Aws::Wickr::Types::User

Inherits:

Struct

• Object
• Struct
• Aws::Wickr::Types::User

Defined in:

gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb

Overview

Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.

codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:first_name, :last_name]

Instance Attribute Summary

• #cell ⇒ String

  The phone number minus country code, used for cloud deployments.

• #challenge_failures ⇒ Integer

  The number of failed password attempts for enterprise deployments, used for account lockout policies.

• #code_validation ⇒ Boolean

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

• #country_code ⇒ String

  The country code for the user's phone number, used for cloud deployments.

• #first_name ⇒ String

  The first name of the user.

• #invite_code ⇒ String

  The invitation code for this user, used during registration to join the network.

• #is_admin ⇒ Boolean

  Indicates whether the user has administrator privileges in the network.

• #is_invite_expired ⇒ Boolean

  Indicates whether the user's email invitation code has expired, applicable to cloud deployments.

• #is_user ⇒ Boolean

  Indicates whether this account is a user (as opposed to a bot or other account type).

• #last_name ⇒ String

  The last name of the user.

• #otp_enabled ⇒ Boolean

  Indicates whether one-time password (OTP) authentication is enabled for the user.

• #scim_id ⇒ String

  The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization.

• #security_groups ⇒ Array<String>

  A list of security group IDs to which the user is assigned, determining their permissions and feature access.

• #status ⇒ Integer

  The current status of the user (1 for pending invitation, 2 for active).

• #suspended ⇒ Boolean

  Indicates whether the user is currently suspended and unable to access the network.

• #type ⇒ String

  The descriptive type of the user account (e.g., 'user').

• #uname ⇒ String

  The unique identifier for the user.

• #user_id ⇒ String

  The unique identifier for the user within the network.

• #username ⇒ String

  The email address or username of the user.

Instance Attribute Details

#cell ⇒ String

The phone number minus country code, used for cloud deployments.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#challenge_failures ⇒ Integer

The number of failed password attempts for enterprise deployments, used for account lockout policies.

Returns:

• (Integer)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#code_validation ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#country_code ⇒ String

The country code for the user's phone number, used for cloud deployments.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#first_name ⇒ String

The first name of the user.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#invite_code ⇒ String

The invitation code for this user, used during registration to join the network.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#is_admin ⇒ Boolean

Indicates whether the user has administrator privileges in the network.

Returns:

• (Boolean)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#is_invite_expired ⇒ Boolean

Indicates whether the user's email invitation code has expired, applicable to cloud deployments.

Returns:

• (Boolean)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#is_user ⇒ Boolean

Indicates whether this account is a user (as opposed to a bot or other account type).

Returns:

• (Boolean)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#last_name ⇒ String

The last name of the user.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#otp_enabled ⇒ Boolean

Indicates whether one-time password (OTP) authentication is enabled for the user.

Returns:

• (Boolean)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#scim_id ⇒ String

The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#security_groups ⇒ Array<String>

A list of security group IDs to which the user is assigned, determining their permissions and feature access.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#status ⇒ Integer

The current status of the user (1 for pending invitation, 2 for active).

Returns:

• (Integer)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#suspended ⇒ Boolean

Indicates whether the user is currently suspended and unable to access the network.

Returns:

• (Boolean)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#type ⇒ String

The descriptive type of the user account (e.g., 'user').

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#uname ⇒ String

The unique identifier for the user.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#user_id ⇒ String

The unique identifier for the user within the network.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#username ⇒ String

The email address or username of the user. For bots, this must end in 'bot'.

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 3686

class User < Struct.new(
  :user_id,
  :first_name,
  :last_name,
  :username,
  :security_groups,
  :is_admin,
  :suspended,
  :status,
  :otp_enabled,
  :scim_id,
  :type,
  :cell,
  :country_code,
  :challenge_failures,
  :is_invite_expired,
  :is_user,
  :invite_code,
  :code_validation,
  :uname)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end