Interface User.Builder

All Superinterfaces:
Buildable, CopyableBuilder<User.Builder,User>, SdkBuilder<User.Builder,User>, SdkPojo
Enclosing class:
User
@Mutable @NotThreadSafe public static interface User.Builder extends SdkPojo, CopyableBuilder<User.Builder,User>

  • Method Details

    • userId

      User.Builder userId(String userId)

      The unique identifier for the user within the network.

      Parameters:
      userId - The unique identifier for the user within the network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firstName

      User.Builder firstName(String firstName)

      The first name of the user.

      Parameters:
      firstName - The first name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastName

      User.Builder lastName(String lastName)

      The last name of the user.

      Parameters:
      lastName - The last name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

      User.Builder username(String username)

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

      Parameters:
      username - The email address or username of the user. For bots, this must end in 'bot'.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      User.Builder securityGroups(Collection<String> securityGroups)

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

      Parameters:
      securityGroups - A list of security group IDs to which the user is assigned, determining their permissions and feature access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      User.Builder securityGroups(String... securityGroups)

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

      Parameters:
      securityGroups - A list of security group IDs to which the user is assigned, determining their permissions and feature access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isAdmin

      User.Builder isAdmin(Boolean isAdmin)

      Indicates whether the user has administrator privileges in the network.

      Parameters:
      isAdmin - Indicates whether the user has administrator privileges in the network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • suspended

      User.Builder suspended(Boolean suspended)

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

      Parameters:
      suspended - Indicates whether the user is currently suspended and unable to access the network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      User.Builder status(Integer status)

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

      Parameters:
      status - The current status of the user (1 for pending invitation, 2 for active).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • otpEnabled

      User.Builder otpEnabled(Boolean otpEnabled)

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

      Parameters:
      otpEnabled - Indicates whether one-time password (OTP) authentication is enabled for the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scimId

      User.Builder scimId(String scimId)

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

      Parameters:
      scimId - The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      User.Builder type(String type)

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

      Parameters:
      type - The descriptive type of the user account (e.g., 'user').
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cell

      User.Builder cell(String cell)

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

      Parameters:
      cell - The phone number minus country code, used for cloud deployments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • countryCode

      User.Builder countryCode(String countryCode)

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

      Parameters:
      countryCode - The country code for the user's phone number, used for cloud deployments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • challengeFailures

      User.Builder challengeFailures(Integer challengeFailures)

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

      Parameters:
      challengeFailures - The number of failed password attempts for enterprise deployments, used for account lockout policies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isInviteExpired

      User.Builder isInviteExpired(Boolean isInviteExpired)

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

      Parameters:
      isInviteExpired - Indicates whether the user's email invitation code has expired, applicable to cloud deployments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isUser

      User.Builder isUser(Boolean isUser)

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

      Parameters:
      isUser - Indicates whether this account is a user (as opposed to a bot or other account type).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inviteCode

      User.Builder inviteCode(String inviteCode)

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

      Parameters:
      inviteCode - The invitation code for this user, used during registration to join the network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeValidation

      User.Builder codeValidation(Boolean codeValidation)

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

      Parameters:
      codeValidation - Indicates whether the user can be verified through a custom invite code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uname

      User.Builder uname(String uname)

      The unique identifier for the user.

      Parameters:
      uname - The unique identifier for the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.