wickr/aws.sdk.kotlin.services.wickr.model/User/Builder

Builder

class Builder

Properties

cell

var cell: String?

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

challengeFailures

var challengeFailures: Int?

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

codeValidation

var codeValidation: Boolean?

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

countryCode

var countryCode: String?

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

firstName

var firstName: String?

The first name of the user.

inviteCode

var inviteCode: String?

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

isAdmin

var isAdmin: Boolean?

Indicates whether the user has administrator privileges in the network.

isInviteExpired

var isInviteExpired: Boolean?

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

isUser

var isUser: Boolean?

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

lastName

var lastName: String?

The last name of the user.

otpEnabled

var otpEnabled: Boolean?

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

scimId

var scimId: String?

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

securityGroups

var securityGroups: List<String>?

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

status

var status: Int?

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

suspended

var suspended: Boolean?

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

type

var type: String?

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

uname

var uname: String?

The unique identifier for the user.

userId

var userId: String?

The unique identifier for the user within the network.

username

var username: String?

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