SecurityGroupSettings ¶

class SecurityGroupSettings(TypedDict, closed=True):
    always_reauthenticate: NotRequired["bool"]
    """<p>Requires users to reauthenticate every time they return to the application, providing an additional layer of security.</p>"""
    atak_package_values: NotRequired[
        "capo_wickr.types.security_group_string_list.SecurityGroupStringList"
    ]
    """<p>Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.</p>"""
    calling: NotRequired["capo_wickr.types.calling_settings.CallingSettings"]
    """<p>The calling feature permissions and settings that control what types of calls users can initiate and participate in.</p>"""
    check_for_updates: NotRequired["bool"]
    """<p>Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.</p>"""
    enable_atak: NotRequired["bool"]
    """<p>Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.</p>"""
    enable_crash_reports: NotRequired["bool"]
    """<p>Allow users to report crashes.</p>"""
    enable_file_download: NotRequired["bool"]
    """<p>Specifies whether users can download files from messages to their devices.</p>"""
    enable_guest_federation: NotRequired["bool"]
    """<p>Allows users to communicate with guest users from other Wickr networks and federated external networks.</p>"""
    enable_notification_preview: NotRequired["bool"]
    """<p>Enables message preview text in push notifications, allowing users to see message content before opening the app.</p>"""
    enable_open_access_option: NotRequired["bool"]
    """<p> Allow users to avoid censorship when they are geo-blocked or have network limitations.</p>"""
    enable_restricted_global_federation: NotRequired["bool"]
    """<p>Enables restricted global federation, limiting external communication to only specified permitted networks.</p>"""
    files_enabled: NotRequired["bool"]
    """<p>Enables file sharing capabilities, allowing users to send and receive files in conversations.</p>"""
    force_device_lockout: NotRequired["int"]
    """<p> Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.</p>"""
    force_open_access: NotRequired["bool"]
    """<p>Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.</p>"""
    force_read_receipts: NotRequired["bool"]
    """<p>Allow user approved bots to read messages in rooms without using a slash command.</p>"""
    global_federation: NotRequired["bool"]
    """<p>Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.</p>"""
    is_ato_enabled: NotRequired["bool"]
    """<p>Enforces a two-factor authentication when a user adds a new device to their account.</p>"""
    is_link_preview_enabled: NotRequired["bool"]
    """<p>Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.</p>"""
    location_allow_maps: NotRequired["bool"]
    """<p>Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.</p>"""
    location_enabled: NotRequired["bool"]
    """<p>Enables location sharing features, allowing users to share their current location with others.</p>"""
    max_auto_download_size: NotRequired["int"]
    """<p>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) ]</p>"""
    max_bor: NotRequired["int"]
    """<p>The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.</p>"""
    max_ttl: NotRequired["int"]
    """<p>The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.</p>"""
    message_forwarding_enabled: NotRequired["bool"]
    """<p>Enables message forwarding, allowing users to forward messages from one conversation to another.</p>"""
    password_requirements: NotRequired[
        "capo_wickr.types.password_requirements.PasswordRequirements"
    ]
    """<p>The password complexity requirements that users must follow when creating or changing passwords.</p>"""
    presence_enabled: NotRequired["bool"]
    """<p>Enables presence indicators that show whether users are online, away, or offline.</p>"""
    quick_responses: NotRequired[
        "capo_wickr.types.security_group_string_list.SecurityGroupStringList"
    ]
    """<p>A list of pre-defined quick response message templates that users can send with a single tap.</p>"""
    show_master_recovery_key: NotRequired["bool"]
    """<p>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.</p>"""
    shredder: NotRequired["capo_wickr.types.shredder_settings.ShredderSettings"]
    """<p>The message shredder configuration that controls secure deletion of messages and files from devices.</p>"""
    sso_max_idle_minutes: NotRequired["int"]
    """<p>The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.</p>"""
    max_non_sso_session_minutes: NotRequired["int"]
    """<p>Maximum session duration in minutes for non-SSO users. Set to 0 to disable. Valid range is 60 to 525600 (1 hour to 365 days).</p>"""
    federation_mode: NotRequired["int"]
    """<p>The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).</p>"""
    lockout_threshold: NotRequired["int"]
    """<p>The number of failed password attempts before a user account is locked out.</p>"""
    permitted_networks: NotRequired[
        "capo_wickr.types.permitted_networks_list.PermittedNetworksList"
    ]
    """<p>A list of network IDs that are permitted for local federation when federation mode is set to restricted.</p>"""
    permitted_wickr_aws_networks: NotRequired[
        "capo_wickr.types.wickr_aws_networks_list.WickrAwsNetworksList"
    ]
    """<p>A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.</p>"""
    permitted_wickr_enterprise_networks: NotRequired[
        "capo_wickr.types.permitted_wickr_enterprise_networks_list.PermittedWickrEnterpriseNetworksList"
    ]
    """<p>A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.</p>"""