/AWS1/CL_WKRSECURITYGROUPSTGS¶
Comprehensive configuration settings that define all user capabilities, restrictions, and features for members of a security group. These settings control everything from calling permissions to federation settings to security policies.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_alwaysreauthenticate TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Requires users to reauthenticate every time they return to the application, providing an additional layer of security.
it_atakpackagevalues TYPE /AWS1/CL_WKRSECGROUPSTRLIST_W=>TT_SECURITYGROUPSTRINGLIST TT_SECURITYGROUPSTRINGLIST¶
Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.
io_calling TYPE REF TO /AWS1/CL_WKRCALLINGSETTINGS /AWS1/CL_WKRCALLINGSETTINGS¶
The calling feature permissions and settings that control what types of calls users can initiate and participate in.
iv_checkforupdates TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.
iv_enableatak TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.
iv_enablecrashreports TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Allow users to report crashes.
iv_enablefiledownload TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Specifies whether users can download files from messages to their devices.
iv_enableguestfederation TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Allows users to communicate with guest users from other Wickr networks and federated external networks.
iv_enablenotificationpreview TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables message preview text in push notifications, allowing users to see message content before opening the app.
iv_enableopenaccessoption TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Allow users to avoid censorship when they are geo-blocked or have network limitations.
iv_enablerestrictedglbfedr8n TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables restricted global federation, limiting external communication to only specified permitted networks.
iv_filesenabled TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables file sharing capabilities, allowing users to send and receive files in conversations.
iv_forcedevicelockout TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.
iv_forceopenaccess TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.
iv_forcereadreceipts TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Allow user approved bots to read messages in rooms without using a slash command.
iv_globalfederation TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.
iv_isatoenabled TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enforces a two-factor authentication when a user adds a new device to their account.
iv_islinkpreviewenabled TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.
iv_locationallowmaps TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.
iv_locationenabled TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables location sharing features, allowing users to share their current location with others.
iv_maxautodownloadsize TYPE /AWS1/WKRLONG /AWS1/WKRLONG¶
The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]
iv_maxbor TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.
iv_maxttl TYPE /AWS1/WKRLONG /AWS1/WKRLONG¶
The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.
iv_messageforwardingenabled TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables message forwarding, allowing users to forward messages from one conversation to another.
io_passwordrequirements TYPE REF TO /AWS1/CL_WKRPASSWORDREQS /AWS1/CL_WKRPASSWORDREQS¶
The password complexity requirements that users must follow when creating or changing passwords.
iv_presenceenabled TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Enables presence indicators that show whether users are online, away, or offline.
it_quickresponses TYPE /AWS1/CL_WKRSECGROUPSTRLIST_W=>TT_SECURITYGROUPSTRINGLIST TT_SECURITYGROUPSTRINGLIST¶
A list of pre-defined quick response message templates that users can send with a single tap.
iv_showmasterrecoverykey TYPE /AWS1/WKRBOOLEAN /AWS1/WKRBOOLEAN¶
Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.
io_shredder TYPE REF TO /AWS1/CL_WKRSHREDDERSETTINGS /AWS1/CL_WKRSHREDDERSETTINGS¶
The message shredder configuration that controls secure deletion of messages and files from devices.
iv_ssomaxidleminutes TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.
iv_federationmode TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).
iv_lockoutthreshold TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The number of failed password attempts before a user account is locked out.
it_permittednetworks TYPE /AWS1/CL_WKRPERMITTEDNETSLST_W=>TT_PERMITTEDNETWORKSLIST TT_PERMITTEDNETWORKSLIST¶
A list of network IDs that are permitted for local federation when federation mode is set to restricted.
it_permittedwickrawsnetworks TYPE /AWS1/CL_WKRWICKRAWSNETWORKS=>TT_WICKRAWSNETWORKSLIST TT_WICKRAWSNETWORKSLIST¶
A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.
it_permittedwickrentrpnets TYPE /AWS1/CL_WKRPERMITTEDWICKREN00=>TT_PERMITTEDWICKRENTRPNETSLIST TT_PERMITTEDWICKRENTRPNETSLIST¶
A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.
Queryable Attributes¶
alwaysReauthenticate¶
Requires users to reauthenticate every time they return to the application, providing an additional layer of security.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALWAYSREAUTHENTICATE() |
Getter for ALWAYSREAUTHENTICATE, with configurable default |
ASK_ALWAYSREAUTHENTICATE() |
Getter for ALWAYSREAUTHENTICATE w/ exceptions if field has n |
HAS_ALWAYSREAUTHENTICATE() |
Determine if ALWAYSREAUTHENTICATE has a value |
atakPackageValues¶
Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATAKPACKAGEVALUES() |
Getter for ATAKPACKAGEVALUES, with configurable default |
ASK_ATAKPACKAGEVALUES() |
Getter for ATAKPACKAGEVALUES w/ exceptions if field has no v |
HAS_ATAKPACKAGEVALUES() |
Determine if ATAKPACKAGEVALUES has a value |
calling¶
The calling feature permissions and settings that control what types of calls users can initiate and participate in.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CALLING() |
Getter for CALLING |
checkForUpdates¶
Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHECKFORUPDATES() |
Getter for CHECKFORUPDATES, with configurable default |
ASK_CHECKFORUPDATES() |
Getter for CHECKFORUPDATES w/ exceptions if field has no val |
HAS_CHECKFORUPDATES() |
Determine if CHECKFORUPDATES has a value |
enableAtak¶
Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLEATAK() |
Getter for ENABLEATAK, with configurable default |
ASK_ENABLEATAK() |
Getter for ENABLEATAK w/ exceptions if field has no value |
HAS_ENABLEATAK() |
Determine if ENABLEATAK has a value |
enableCrashReports¶
Allow users to report crashes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLECRASHREPORTS() |
Getter for ENABLECRASHREPORTS, with configurable default |
ASK_ENABLECRASHREPORTS() |
Getter for ENABLECRASHREPORTS w/ exceptions if field has no |
HAS_ENABLECRASHREPORTS() |
Determine if ENABLECRASHREPORTS has a value |
enableFileDownload¶
Specifies whether users can download files from messages to their devices.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLEFILEDOWNLOAD() |
Getter for ENABLEFILEDOWNLOAD, with configurable default |
ASK_ENABLEFILEDOWNLOAD() |
Getter for ENABLEFILEDOWNLOAD w/ exceptions if field has no |
HAS_ENABLEFILEDOWNLOAD() |
Determine if ENABLEFILEDOWNLOAD has a value |
enableGuestFederation¶
Allows users to communicate with guest users from other Wickr networks and federated external networks.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLEGUESTFEDERATION() |
Getter for ENABLEGUESTFEDERATION, with configurable default |
ASK_ENABLEGUESTFEDERATION() |
Getter for ENABLEGUESTFEDERATION w/ exceptions if field has |
HAS_ENABLEGUESTFEDERATION() |
Determine if ENABLEGUESTFEDERATION has a value |
enableNotificationPreview¶
Enables message preview text in push notifications, allowing users to see message content before opening the app.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLENOTIFPREVIEW() |
Getter for ENABLENOTIFICATIONPREVIEW, with configurable defa |
ASK_ENABLENOTIFPREVIEW() |
Getter for ENABLENOTIFICATIONPREVIEW w/ exceptions if field |
HAS_ENABLENOTIFPREVIEW() |
Determine if ENABLENOTIFICATIONPREVIEW has a value |
enableOpenAccessOption¶
Allow users to avoid censorship when they are geo-blocked or have network limitations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLEOPENACCESSOPTION() |
Getter for ENABLEOPENACCESSOPTION, with configurable default |
ASK_ENABLEOPENACCESSOPTION() |
Getter for ENABLEOPENACCESSOPTION w/ exceptions if field has |
HAS_ENABLEOPENACCESSOPTION() |
Determine if ENABLEOPENACCESSOPTION has a value |
enableRestrictedGlobalFederation¶
Enables restricted global federation, limiting external communication to only specified permitted networks.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENBRESTRICTEDGLBFEDR8N() |
Getter for ENABLERESTRICTEDGLOBALFEDR8N, with configurable d |
ASK_ENBRESTRICTEDGLBFEDR8N() |
Getter for ENABLERESTRICTEDGLOBALFEDR8N w/ exceptions if fie |
HAS_ENBRESTRICTEDGLBFEDR8N() |
Determine if ENABLERESTRICTEDGLOBALFEDR8N has a value |
filesEnabled¶
Enables file sharing capabilities, allowing users to send and receive files in conversations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILESENABLED() |
Getter for FILESENABLED, with configurable default |
ASK_FILESENABLED() |
Getter for FILESENABLED w/ exceptions if field has no value |
HAS_FILESENABLED() |
Determine if FILESENABLED has a value |
forceDeviceLockout¶
Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FORCEDEVICELOCKOUT() |
Getter for FORCEDEVICELOCKOUT, with configurable default |
ASK_FORCEDEVICELOCKOUT() |
Getter for FORCEDEVICELOCKOUT w/ exceptions if field has no |
HAS_FORCEDEVICELOCKOUT() |
Determine if FORCEDEVICELOCKOUT has a value |
forceOpenAccess¶
Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FORCEOPENACCESS() |
Getter for FORCEOPENACCESS, with configurable default |
ASK_FORCEOPENACCESS() |
Getter for FORCEOPENACCESS w/ exceptions if field has no val |
HAS_FORCEOPENACCESS() |
Determine if FORCEOPENACCESS has a value |
forceReadReceipts¶
Allow user approved bots to read messages in rooms without using a slash command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FORCEREADRECEIPTS() |
Getter for FORCEREADRECEIPTS, with configurable default |
ASK_FORCEREADRECEIPTS() |
Getter for FORCEREADRECEIPTS w/ exceptions if field has no v |
HAS_FORCEREADRECEIPTS() |
Determine if FORCEREADRECEIPTS has a value |
globalFederation¶
Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GLOBALFEDERATION() |
Getter for GLOBALFEDERATION, with configurable default |
ASK_GLOBALFEDERATION() |
Getter for GLOBALFEDERATION w/ exceptions if field has no va |
HAS_GLOBALFEDERATION() |
Determine if GLOBALFEDERATION has a value |
isAtoEnabled¶
Enforces a two-factor authentication when a user adds a new device to their account.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISATOENABLED() |
Getter for ISATOENABLED, with configurable default |
ASK_ISATOENABLED() |
Getter for ISATOENABLED w/ exceptions if field has no value |
HAS_ISATOENABLED() |
Determine if ISATOENABLED has a value |
isLinkPreviewEnabled¶
Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISLINKPREVIEWENABLED() |
Getter for ISLINKPREVIEWENABLED, with configurable default |
ASK_ISLINKPREVIEWENABLED() |
Getter for ISLINKPREVIEWENABLED w/ exceptions if field has n |
HAS_ISLINKPREVIEWENABLED() |
Determine if ISLINKPREVIEWENABLED has a value |
locationAllowMaps¶
Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOCATIONALLOWMAPS() |
Getter for LOCATIONALLOWMAPS, with configurable default |
ASK_LOCATIONALLOWMAPS() |
Getter for LOCATIONALLOWMAPS w/ exceptions if field has no v |
HAS_LOCATIONALLOWMAPS() |
Determine if LOCATIONALLOWMAPS has a value |
locationEnabled¶
Enables location sharing features, allowing users to share their current location with others.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOCATIONENABLED() |
Getter for LOCATIONENABLED, with configurable default |
ASK_LOCATIONENABLED() |
Getter for LOCATIONENABLED w/ exceptions if field has no val |
HAS_LOCATIONENABLED() |
Determine if LOCATIONENABLED has a value |
maxAutoDownloadSize¶
The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXAUTODOWNLOADSIZE() |
Getter for MAXAUTODOWNLOADSIZE, with configurable default |
ASK_MAXAUTODOWNLOADSIZE() |
Getter for MAXAUTODOWNLOADSIZE w/ exceptions if field has no |
HAS_MAXAUTODOWNLOADSIZE() |
Determine if MAXAUTODOWNLOADSIZE has a value |
maxBor¶
The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXBOR() |
Getter for MAXBOR, with configurable default |
ASK_MAXBOR() |
Getter for MAXBOR w/ exceptions if field has no value |
HAS_MAXBOR() |
Determine if MAXBOR has a value |
maxTtl¶
The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXTTL() |
Getter for MAXTTL, with configurable default |
ASK_MAXTTL() |
Getter for MAXTTL w/ exceptions if field has no value |
HAS_MAXTTL() |
Determine if MAXTTL has a value |
messageForwardingEnabled¶
Enables message forwarding, allowing users to forward messages from one conversation to another.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGEFORWARDINGENABLED() |
Getter for MESSAGEFORWARDINGENABLED, with configurable defau |
ASK_MESSAGEFORWARDINGENABLED() |
Getter for MESSAGEFORWARDINGENABLED w/ exceptions if field h |
HAS_MESSAGEFORWARDINGENABLED() |
Determine if MESSAGEFORWARDINGENABLED has a value |
passwordRequirements¶
The password complexity requirements that users must follow when creating or changing passwords.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PASSWORDREQUIREMENTS() |
Getter for PASSWORDREQUIREMENTS |
presenceEnabled¶
Enables presence indicators that show whether users are online, away, or offline.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRESENCEENABLED() |
Getter for PRESENCEENABLED, with configurable default |
ASK_PRESENCEENABLED() |
Getter for PRESENCEENABLED w/ exceptions if field has no val |
HAS_PRESENCEENABLED() |
Determine if PRESENCEENABLED has a value |
quickResponses¶
A list of pre-defined quick response message templates that users can send with a single tap.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUICKRESPONSES() |
Getter for QUICKRESPONSES, with configurable default |
ASK_QUICKRESPONSES() |
Getter for QUICKRESPONSES w/ exceptions if field has no valu |
HAS_QUICKRESPONSES() |
Determine if QUICKRESPONSES has a value |
showMasterRecoveryKey¶
Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHOWMASTERRECOVERYKEY() |
Getter for SHOWMASTERRECOVERYKEY, with configurable default |
ASK_SHOWMASTERRECOVERYKEY() |
Getter for SHOWMASTERRECOVERYKEY w/ exceptions if field has |
HAS_SHOWMASTERRECOVERYKEY() |
Determine if SHOWMASTERRECOVERYKEY has a value |
shredder¶
The message shredder configuration that controls secure deletion of messages and files from devices.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHREDDER() |
Getter for SHREDDER |
ssoMaxIdleMinutes¶
The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSOMAXIDLEMINUTES() |
Getter for SSOMAXIDLEMINUTES, with configurable default |
ASK_SSOMAXIDLEMINUTES() |
Getter for SSOMAXIDLEMINUTES w/ exceptions if field has no v |
HAS_SSOMAXIDLEMINUTES() |
Determine if SSOMAXIDLEMINUTES has a value |
federationMode¶
The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FEDERATIONMODE() |
Getter for FEDERATIONMODE, with configurable default |
ASK_FEDERATIONMODE() |
Getter for FEDERATIONMODE w/ exceptions if field has no valu |
HAS_FEDERATIONMODE() |
Determine if FEDERATIONMODE has a value |
lockoutThreshold¶
The number of failed password attempts before a user account is locked out.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOCKOUTTHRESHOLD() |
Getter for LOCKOUTTHRESHOLD, with configurable default |
ASK_LOCKOUTTHRESHOLD() |
Getter for LOCKOUTTHRESHOLD w/ exceptions if field has no va |
HAS_LOCKOUTTHRESHOLD() |
Determine if LOCKOUTTHRESHOLD has a value |
permittedNetworks¶
A list of network IDs that are permitted for local federation when federation mode is set to restricted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERMITTEDNETWORKS() |
Getter for PERMITTEDNETWORKS, with configurable default |
ASK_PERMITTEDNETWORKS() |
Getter for PERMITTEDNETWORKS w/ exceptions if field has no v |
HAS_PERMITTEDNETWORKS() |
Determine if PERMITTEDNETWORKS has a value |
permittedWickrAwsNetworks¶
A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERMITTEDWICKRAWSNETS() |
Getter for PERMITTEDWICKRAWSNETWORKS, with configurable defa |
ASK_PERMITTEDWICKRAWSNETS() |
Getter for PERMITTEDWICKRAWSNETWORKS w/ exceptions if field |
HAS_PERMITTEDWICKRAWSNETS() |
Determine if PERMITTEDWICKRAWSNETWORKS has a value |
permittedWickrEnterpriseNetworks¶
A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERMITTEDWICKRENTRPNETS() |
Getter for PERMITTEDWICKRENTRPNETWORKS, with configurable de |
ASK_PERMITTEDWICKRENTRPNETS() |
Getter for PERMITTEDWICKRENTRPNETWORKS w/ exceptions if fiel |
HAS_PERMITTEDWICKRENTRPNETS() |
Determine if PERMITTEDWICKRENTRPNETWORKS has a value |