Class User

java.lang.Object
software.amazon.awssdk.services.wickr.model.User
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<User.Builder,User>
@Generated("software.amazon.awssdk:codegen") public final class User extends Object implements SdkPojo, Serializable, ToCopyableBuilder<User.Builder,User>

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:

  • Method Details

    • userId

      public final String userId()

      The unique identifier for the user within the network.

      Returns:
      The unique identifier for the user within the network.

    • firstName

      public final String firstName()

      The first name of the user.

      Returns:
      The first name of the user.

    • lastName

      public final String lastName()

      The last name of the user.

      Returns:
      The last name of the user.

    • username

      public final String username()

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

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

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroups

      public final List<String> securityGroups()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

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

    • isAdmin

      public final Boolean isAdmin()

      Indicates whether the user has administrator privileges in the network.

      Returns:
      Indicates whether the user has administrator privileges in the network.

    • suspended

      public final Boolean suspended()

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

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

    • status

      public final Integer status()

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

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

    • otpEnabled

      public final Boolean otpEnabled()

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

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

    • scimId

      public final String scimId()

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

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

    • type

      public final String type()

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

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

    • cell

      public final String cell()

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

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

    • countryCode

      public final String countryCode()

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

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

    • challengeFailures

      public final Integer challengeFailures()

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

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

    • isInviteExpired

      public final Boolean isInviteExpired()

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

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

    • isUser

      public final Boolean isUser()

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

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

    • inviteCode

      public final String inviteCode()

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

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

    • codeValidation

      public final Boolean codeValidation()

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

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

    • uname

      public final String uname()

      The unique identifier for the user.

      Returns:
      The unique identifier for the user.

    • toBuilder

      public User.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<User.Builder,User>
      Returns:
      a builder for type T

    • builder

      public static User.Builder builder()

    • serializableBuilderClass

      public static Class<? extends User.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.