Module Values.SecurityGroupSettingsSource

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.

Sourcetype nonrec t = {
  1. alwaysReauthenticate : Boolean.t option;
    (*

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

    *)
  2. atakPackageValues : SecurityGroupStringList.t option;
    (*

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

    *)
  3. calling : CallingSettings.t option;
    (*

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

    *)
  4. checkForUpdates : Boolean.t option;
    (*

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

    *)
  5. enableAtak : Boolean.t option;
    (*

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

    *)
  6. enableCrashReports : Boolean.t option;
    (*

    Allow users to report crashes.

    *)
  7. enableFileDownload : Boolean.t option;
    (*

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

    *)
  8. enableGuestFederation : Boolean.t option;
    (*

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

    *)
  9. enableNotificationPreview : Boolean.t option;
    (*

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

    *)
  10. enableOpenAccessOption : Boolean.t option;
    (*

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

    *)
  11. enableRestrictedGlobalFederation : Boolean.t option;
    (*

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

    *)
  12. filesEnabled : Boolean.t option;
    (*

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

    *)
  13. forceDeviceLockout : Integer.t option;
    (*

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

    *)
  14. forceOpenAccess : Boolean.t option;
    (*

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

    *)
  15. forceReadReceipts : Boolean.t option;
    (*

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

    *)
  16. globalFederation : Boolean.t option;
    (*

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

    *)
  17. isAtoEnabled : Boolean.t option;
    (*

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

    *)
  18. isLinkPreviewEnabled : Boolean.t option;
    (*

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

    *)
  19. locationAllowMaps : Boolean.t option;
    (*

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

    *)
  20. locationEnabled : Boolean.t option;
    (*

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

    *)
  21. maxAutoDownloadSize : Long.t option;
    (*

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

    *)
  22. maxBor : Integer.t option;
    (*

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

    *)
  23. maxTtl : Long.t option;
    (*

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

    *)
  24. messageForwardingEnabled : Boolean.t option;
    (*

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

    *)
  25. passwordRequirements : PasswordRequirements.t option;
    (*

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

    *)
  26. presenceEnabled : Boolean.t option;
    (*

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

    *)
  27. quickResponses : SecurityGroupStringList.t option;
    (*

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

    *)
  28. showMasterRecoveryKey : Boolean.t option;
    (*

    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.

    *)
  29. shredder : ShredderSettings.t option;
    (*

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

    *)
  30. ssoMaxIdleMinutes : Integer.t option;
    (*

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

    *)
  31. federationMode : Integer.t option;
    (*

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

    *)
  32. lockoutThreshold : Integer.t option;
    (*

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

    *)
  33. permittedNetworks : PermittedNetworksList.t option;
    (*

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

    *)
  34. permittedWickrAwsNetworks : WickrAwsNetworksList.t option;
    (*

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

    *)
  35. permittedWickrEnterpriseNetworks : PermittedWickrEnterpriseNetworksList.t option;
    (*

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

    *)
}
Sourceval make : ?alwaysReauthenticate:??? -> ?atakPackageValues:??? -> ?calling:??? -> ?checkForUpdates:??? -> ?enableAtak:??? -> ?enableCrashReports:??? -> ?enableFileDownload:??? -> ?enableGuestFederation:??? -> ?enableNotificationPreview:??? -> ?enableOpenAccessOption:??? -> ?enableRestrictedGlobalFederation:??? -> ?filesEnabled:??? -> ?forceDeviceLockout:??? -> ?forceOpenAccess:??? -> ?forceReadReceipts:??? -> ?globalFederation:??? -> ?isAtoEnabled:??? -> ?isLinkPreviewEnabled:??? -> ?locationAllowMaps:??? -> ?locationEnabled:??? -> ?maxAutoDownloadSize:??? -> ?maxBor:??? -> ?maxTtl:??? -> ?messageForwardingEnabled:??? -> ?passwordRequirements:??? -> ?presenceEnabled:??? -> ?quickResponses:??? -> ?showMasterRecoveryKey:??? -> ?shredder:??? -> ?ssoMaxIdleMinutes:??? -> ?federationMode:??? -> ?lockoutThreshold:??? -> ?permittedNetworks:??? -> ?permittedWickrAwsNetworks:??? -> ?permittedWickrEnterpriseNetworks:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of GenericString.t | `Structure of (string * [> `String of GenericString.t ]) list ] list | `Long of Long.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t