/AWS1/CL_WKRUSER¶
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.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_userid TYPE /AWS1/WKRUSERID /AWS1/WKRUSERID¶
The unique identifier for the user within the network.
iv_firstname TYPE /AWS1/WKRSENSITIVESTRING /AWS1/WKRSENSITIVESTRING¶
The first name of the user.
iv_lastname TYPE /AWS1/WKRSENSITIVESTRING /AWS1/WKRSENSITIVESTRING¶
The last name of the user.
iv_username TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The email address or username of the user. For bots, this must end in 'bot'.
it_securitygroups TYPE /AWS1/CL_WKRSECGROUPIDLIST_W=>TT_SECURITYGROUPIDLIST TT_SECURITYGROUPIDLIST¶
A list of security group IDs to which the user is assigned, determining their permissions and feature access.
iv_isadmin TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Indicates whether the user has administrator privileges in the network.
iv_suspended TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Indicates whether the user is currently suspended and unable to access the network.
iv_status TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The current status of the user (1 for pending invitation, 2 for active).
iv_otpenabled TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Indicates whether one-time password (OTP) authentication is enabled for the user.
iv_scimid TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.
iv_type TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The descriptive type of the user account (e.g., 'user').
iv_cell TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The phone number minus country code, used for cloud deployments.
iv_countrycode TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The country code for the user's phone number, used for cloud deployments.
iv_challengefailures TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The number of failed password attempts for enterprise deployments, used for account lockout policies.
iv_isinviteexpired TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Indicates whether the user's email invitation code has expired, applicable to cloud deployments.
iv_isuser TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Indicates whether this account is a user (as opposed to a bot or other account type).
iv_invitecode TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The invitation code for this user, used during registration to join the network.
iv_codevalidation TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Indicates whether the user can be verified through a custom invite code.
iv_uname TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The unique identifier for the user.
Queryable Attributes¶
userId¶
The unique identifier for the user within the network.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERID() |
Getter for USERID, with configurable default |
ASK_USERID() |
Getter for USERID w/ exceptions if field has no value |
HAS_USERID() |
Determine if USERID has a value |
firstName¶
The first name of the user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FIRSTNAME() |
Getter for FIRSTNAME, with configurable default |
ASK_FIRSTNAME() |
Getter for FIRSTNAME w/ exceptions if field has no value |
HAS_FIRSTNAME() |
Determine if FIRSTNAME has a value |
lastName¶
The last name of the user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTNAME() |
Getter for LASTNAME, with configurable default |
ASK_LASTNAME() |
Getter for LASTNAME w/ exceptions if field has no value |
HAS_LASTNAME() |
Determine if LASTNAME has a value |
username¶
The email address or username of the user. For bots, this must end in 'bot'.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERNAME() |
Getter for USERNAME, with configurable default |
ASK_USERNAME() |
Getter for USERNAME w/ exceptions if field has no value |
HAS_USERNAME() |
Determine if USERNAME has a value |
securityGroups¶
A list of security group IDs to which the user is assigned, determining their permissions and feature access.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECURITYGROUPS() |
Getter for SECURITYGROUPS, with configurable default |
ASK_SECURITYGROUPS() |
Getter for SECURITYGROUPS w/ exceptions if field has no valu |
HAS_SECURITYGROUPS() |
Determine if SECURITYGROUPS has a value |
isAdmin¶
Indicates whether the user has administrator privileges in the network.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISADMIN() |
Getter for ISADMIN, with configurable default |
ASK_ISADMIN() |
Getter for ISADMIN w/ exceptions if field has no value |
HAS_ISADMIN() |
Determine if ISADMIN has a value |
suspended¶
Indicates whether the user is currently suspended and unable to access the network.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUSPENDED() |
Getter for SUSPENDED, with configurable default |
ASK_SUSPENDED() |
Getter for SUSPENDED w/ exceptions if field has no value |
HAS_SUSPENDED() |
Determine if SUSPENDED has a value |
status¶
The current status of the user (1 for pending invitation, 2 for active).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
otpEnabled¶
Indicates whether one-time password (OTP) authentication is enabled for the user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OTPENABLED() |
Getter for OTPENABLED, with configurable default |
ASK_OTPENABLED() |
Getter for OTPENABLED w/ exceptions if field has no value |
HAS_OTPENABLED() |
Determine if OTPENABLED has a value |
scimId¶
The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCIMID() |
Getter for SCIMID, with configurable default |
ASK_SCIMID() |
Getter for SCIMID w/ exceptions if field has no value |
HAS_SCIMID() |
Determine if SCIMID has a value |
type¶
The descriptive type of the user account (e.g., 'user').
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
cell¶
The phone number minus country code, used for cloud deployments.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CELL() |
Getter for CELL, with configurable default |
ASK_CELL() |
Getter for CELL w/ exceptions if field has no value |
HAS_CELL() |
Determine if CELL has a value |
countryCode¶
The country code for the user's phone number, used for cloud deployments.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COUNTRYCODE() |
Getter for COUNTRYCODE, with configurable default |
ASK_COUNTRYCODE() |
Getter for COUNTRYCODE w/ exceptions if field has no value |
HAS_COUNTRYCODE() |
Determine if COUNTRYCODE has a value |
challengeFailures¶
The number of failed password attempts for enterprise deployments, used for account lockout policies.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHALLENGEFAILURES() |
Getter for CHALLENGEFAILURES, with configurable default |
ASK_CHALLENGEFAILURES() |
Getter for CHALLENGEFAILURES w/ exceptions if field has no v |
HAS_CHALLENGEFAILURES() |
Determine if CHALLENGEFAILURES has a value |
isInviteExpired¶
Indicates whether the user's email invitation code has expired, applicable to cloud deployments.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISINVITEEXPIRED() |
Getter for ISINVITEEXPIRED, with configurable default |
ASK_ISINVITEEXPIRED() |
Getter for ISINVITEEXPIRED w/ exceptions if field has no val |
HAS_ISINVITEEXPIRED() |
Determine if ISINVITEEXPIRED has a value |
isUser¶
Indicates whether this account is a user (as opposed to a bot or other account type).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISUSER() |
Getter for ISUSER, with configurable default |
ASK_ISUSER() |
Getter for ISUSER w/ exceptions if field has no value |
HAS_ISUSER() |
Determine if ISUSER has a value |
inviteCode¶
The invitation code for this user, used during registration to join the network.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INVITECODE() |
Getter for INVITECODE, with configurable default |
ASK_INVITECODE() |
Getter for INVITECODE w/ exceptions if field has no value |
HAS_INVITECODE() |
Determine if INVITECODE has a value |
codeValidation¶
Indicates whether the user can be verified through a custom invite code.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CODEVALIDATION() |
Getter for CODEVALIDATION, with configurable default |
ASK_CODEVALIDATION() |
Getter for CODEVALIDATION w/ exceptions if field has no valu |
HAS_CODEVALIDATION() |
Determine if CODEVALIDATION has a value |
uname¶
The unique identifier for the user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UNAME() |
Getter for UNAME, with configurable default |
ASK_UNAME() |
Getter for UNAME w/ exceptions if field has no value |
HAS_UNAME() |
Determine if UNAME has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_USERS¶
TYPES TT_USERS TYPE STANDARD TABLE OF REF TO /AWS1/CL_WKRUSER WITH DEFAULT KEY
.