SecurityGroupSettings - AWS Wickr

SecurityGroupSettings

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.

Contents

Note

In the following list, the required parameters are described first.

alwaysReauthenticate

Requires users to reauthenticate every time they return to the application, providing an additional layer of security.

Type: Boolean

Required: No

atakPackageValues

Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.

Type: Array of strings

Pattern: [\S\s]*

Required: No

calling

The calling feature permissions and settings that control what types of calls users can initiate and participate in.

Type: CallingSettings object

Required: No

checkForUpdates

Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.

Type: Boolean

Required: No

enableAtak

Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.

Type: Boolean

Required: No

enableCrashReports

Allow users to report crashes.

Type: Boolean

Required: No

enableFileDownload

Specifies whether users can download files from messages to their devices.

Type: Boolean

Required: No

enableGuestFederation

Allows users to communicate with guest users from other Wickr networks and federated external networks.

Type: Boolean

Required: No

enableNotificationPreview

Enables message preview text in push notifications, allowing users to see message content before opening the app.

Type: Boolean

Required: No

enableOpenAccessOption

Allow users to avoid censorship when they are geo-blocked or have network limitations.

Type: Boolean

Required: No

enableRestrictedGlobalFederation

Enables restricted global federation, limiting external communication to only specified permitted networks.

Type: Boolean

Required: No

federationMode

The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).

Type: Integer

Required: No

filesEnabled

Enables file sharing capabilities, allowing users to send and receive files in conversations.

Type: Boolean

Required: No

forceDeviceLockout

Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.

Type: Integer

Required: No

forceOpenAccess

Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.

Type: Boolean

Required: No

forceReadReceipts

Allow user approved bots to read messages in rooms without using a slash command.

Type: Boolean

Required: No

globalFederation

Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.

Type: Boolean

Required: No

isAtoEnabled

Enforces a two-factor authentication when a user adds a new device to their account.

Type: Boolean

Required: No

isLinkPreviewEnabled

Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.

Type: Boolean

Required: No

locationAllowMaps

Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.

Type: Boolean

Required: No

locationEnabled

Enables location sharing features, allowing users to share their current location with others.

Type: Boolean

Required: No

lockoutThreshold

The number of failed password attempts before a user account is locked out.

Type: Integer

Required: No

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) ]

Type: Long

Required: No

maxBor

The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.

Type: Integer

Required: No

maxTtl

The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.

Type: Long

Required: No

messageForwardingEnabled

Enables message forwarding, allowing users to forward messages from one conversation to another.

Type: Boolean

Required: No

passwordRequirements

The password complexity requirements that users must follow when creating or changing passwords.

Type: PasswordRequirements object

Required: No

permittedNetworks

A list of network IDs that are permitted for local federation when federation mode is set to restricted.

Type: Array of strings

Length Constraints: Fixed length of 8.

Pattern: [0-9]{8}

Required: No

permittedWickrAwsNetworks

A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.

Type: Array of WickrAwsNetworks objects

Required: No

permittedWickrEnterpriseNetworks

A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.

Type: Array of PermittedWickrEnterpriseNetwork objects

Required: No

presenceEnabled

Enables presence indicators that show whether users are online, away, or offline.

Type: Boolean

Required: No

quickResponses

A list of pre-defined quick response message templates that users can send with a single tap.

Type: Array of strings

Pattern: [\S\s]*

Required: No

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.

Type: Boolean

Required: No

shredder

The message shredder configuration that controls secure deletion of messages and files from devices.

Type: ShredderSettings object

Required: No

ssoMaxIdleMinutes

The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: