User
Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.
Note
codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.
Contents
Note
In the following list, the required parameters are described first.
- cell
-
The phone number minus country code, used for cloud deployments.
Type: String
Pattern:
[\S\s]*Required: No
- challengeFailures
-
The number of failed password attempts for enterprise deployments, used for account lockout policies.
Type: Integer
Required: No
- codeValidation
-
Indicates whether the user can be verified through a custom invite code.
Type: Boolean
Required: No
- countryCode
-
The country code for the user's phone number, used for cloud deployments.
Type: String
Pattern:
[\S\s]*Required: No
- firstName
-
The first name of the user.
Type: String
Pattern:
[\S\s]*Required: No
- inviteCode
-
The invitation code for this user, used during registration to join the network.
Type: String
Pattern:
[\S\s]*Required: No
- isAdmin
-
Indicates whether the user has administrator privileges in the network.
Type: Boolean
Required: No
- isInviteExpired
-
Indicates whether the user's email invitation code has expired, applicable to cloud deployments.
Type: Boolean
Required: No
- isUser
-
Indicates whether this account is a user (as opposed to a bot or other account type).
Type: Boolean
Required: No
- lastName
-
The last name of the user.
Type: String
Pattern:
[\S\s]*Required: No
- otpEnabled
-
Indicates whether one-time password (OTP) authentication is enabled for the user.
Type: Boolean
Required: No
- scimId
-
The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.
Type: String
Pattern:
[\S\s]*Required: No
- securityGroups
-
A list of security group IDs to which the user is assigned, determining their permissions and feature access.
Type: Array of strings
Pattern:
[\S]+Required: No
- status
-
The current status of the user (1 for pending invitation, 2 for active).
Type: Integer
Required: No
- suspended
-
Indicates whether the user is currently suspended and unable to access the network.
Type: Boolean
Required: No
- type
-
The descriptive type of the user account (e.g., 'user').
Type: String
Pattern:
[\S\s]*Required: No
- uname
-
The unique identifier for the user.
Type: String
Pattern:
[\S\s]*Required: No
- userId
-
The unique identifier for the user within the network.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern:
[0-9]+Required: No
- username
-
The email address or username of the user. For bots, this must end in 'bot'.
Type: String
Pattern:
[\S\s]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
