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

User

class 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.

Types

Builder

class Builder

Companion

object Companion

Properties

cell

val cell: String?

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

challengeFailures

val challengeFailures: Int?

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

codeValidation

val codeValidation: Boolean?

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

countryCode

val countryCode: String?

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

firstName

val firstName: String?

The first name of the user.

inviteCode

val inviteCode: String?

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

isAdmin

val isAdmin: Boolean?

Indicates whether the user has administrator privileges in the network.

isInviteExpired

val isInviteExpired: Boolean?

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

isUser

val isUser: Boolean?

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

lastName

val lastName: String?

The last name of the user.

otpEnabled

val otpEnabled: Boolean?

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

scimId

val scimId: String?

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

securityGroups

val securityGroups: List<String>?

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

status

val status: Int?

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

suspended

val suspended: Boolean?

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

type

val type: String?

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

uname

val uname: String?

The unique identifier for the user.

userId

val userId: String?

The unique identifier for the user within the network.

username

val username: String?

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

Functions

copy

inline fun copy(block: User.Builder.() -> Unit = {}): User

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String