---
title: "GET /networks/{networkId}/security-groups"
method: GET
path: "/networks/{networkId}/security-groups"
---

# GET /networks/{networkId}/security-groups

`GET /networks/{networkId}/security-groups`

Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.

## Path parameters

- `networkId` string, required

## Query parameters

- `nextToken` string
- `maxResults` integer
- `sortFields` string
- `sortDirection` 'ASC' | 'DESC'

## Response `200`

Success

- ListSecurityGroupsResponse
  - `securityGroups` SecurityGroup[] — A list of security group objects in the current page.
    - `activeMembers` integer, required — The number of active user members currently in the security group.
    - `botMembers` integer, required — The number of bot members currently in the security group.
    - `activeDirectoryGuid` string — The GUID of the Active Directory group associated with this security group, if synchronized with LDAP.
    - `id` string, required — The unique identifier of the security group.
    - `isDefault` boolean, required — Indicates whether this is the default security group for the network. Each network has only one default group.
    - `name` string, required — The human-readable name of the security group.
    - `modified` integer, required — The timestamp when the security group was last modified, specified in epoch seconds.
    - `securityGroupSettings` object, required — The comprehensive configuration settings that define capabilities and restrictions for members of this security group.
      - `alwaysReauthenticate` boolean — Requires users to reauthenticate every time they return to the application, providing an additional layer of security.
      - `atakPackageValues` GenericString[] — Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.
      - `calling` object — The calling feature permissions and settings that control what types of calls users can initiate and participate in.
        - `canStart11Call` boolean — Specifies whether users can start one-to-one calls.
        - `canVideoCall` boolean — Specifies whether users can make video calls (as opposed to audio-only calls). Valid only when audio call(canStart11Call) is enabled.
        - `forceTcpCall` boolean — When enabled, forces all calls to use TCP protocol instead of UDP for network traversal.
      - `checkForUpdates` boolean — Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.
      - `enableAtak` boolean — Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.
      - `enableCrashReports` boolean — Allow users to report crashes.
      - `enableFileDownload` boolean — Specifies whether users can download files from messages to their devices.
      - `enableGuestFederation` boolean — Allows users to communicate with guest users from other Wickr networks and federated external networks.
      - `enableNotificationPreview` boolean — Enables message preview text in push notifications, allowing users to see message content before opening the app.
      - `enableOpenAccessOption` boolean — Allow users to avoid censorship when they are geo-blocked or have network limitations.
      - `enableRestrictedGlobalFederation` boolean — Enables restricted global federation, limiting external communication to only specified permitted networks.
      - `filesEnabled` boolean — Enables file sharing capabilities, allowing users to send and receive files in conversations.
      - `forceDeviceLockout` integer — Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.
      - `forceOpenAccess` boolean — Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.
      - `forceReadReceipts` boolean — Allow user approved bots to read messages in rooms without using a slash command.
      - `globalFederation` boolean — Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.
      - `isAtoEnabled` boolean — Enforces a two-factor authentication when a user adds a new device to their account.
      - `isLinkPreviewEnabled` boolean — Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.
      - `locationAllowMaps` boolean — Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.
      - `locationEnabled` boolean — Enables location sharing features, allowing users to share their current location with others.
      - `maxAutoDownloadSize` integer — 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) ]
      - `maxBor` integer — The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.
      - `maxTtl` integer — The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.
      - `messageForwardingEnabled` boolean — Enables message forwarding, allowing users to forward messages from one conversation to another.
      - `passwordRequirements` object — The password complexity requirements that users must follow when creating or changing passwords.
        - `lowercase` integer — The minimum number of lowercase letters required in passwords.
        - `minLength` integer — The minimum password length in characters.
        - `numbers` integer — The minimum number of numeric characters required in passwords.
        - `symbols` integer — The minimum number of special symbol characters required in passwords.
        - `uppercase` integer — The minimum number of uppercase letters required in passwords.
      - `presenceEnabled` boolean — Enables presence indicators that show whether users are online, away, or offline.
      - `quickResponses` GenericString[] — A list of pre-defined quick response message templates that users can send with a single tap.
      - `showMasterRecoveryKey` boolean — 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.
      - `shredder` object — The message shredder configuration that controls secure deletion of messages and files from devices.
        - `canProcessManually` boolean — Specifies whether users can manually trigger the shredder to delete content.
        - `intensity` integer — <p>Controls the rate (MB/minute) at which the shredder function runs on clients. Valid Values: Must be one of [0, 20, 60, 100].</p> <note> <p>A higher intensity setting could lead to higher battery usage on mobile devices.</p> </note>
      - `ssoMaxIdleMinutes` integer — The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.
      - `maxNonSsoSessionMinutes` integer — 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).
      - `federationMode` integer — The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).
      - `lockoutThreshold` integer — The number of failed password attempts before a user account is locked out.
      - `permittedNetworks` NetworkId[] — A list of network IDs that are permitted for local federation when federation mode is set to restricted.
      - `permittedWickrAwsNetworks` WickrAwsNetworks[] — A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.
        - `region` string, required — The Amazon Web Services region identifier where the network is hosted (e.g., 'us-east-1').
        - `networkId` string, required — The network ID of the Wickr Amazon Web Services network.
      - `permittedWickrEnterpriseNetworks` PermittedWickrEnterpriseNetwork[] — A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.
        - `domain` string, required — The domain identifier for the permitted Wickr enterprise network.
        - `networkId` string, required — The network ID of the permitted Wickr enterprise network.
  - `nextToken` string — The token to use for retrieving the next page of results. If this is not present, there are no more results.

## Other responses

- `480` — ValidationError
- `481` — BadRequestError
- `482` — ResourceNotFoundError
- `483` — ForbiddenError
- `484` — UnauthorizedError
- `485` — InternalServerError
- `486` — RateLimitError

---

[API](https://skmtc.net/aws/apis/wickr.md) · [All operations](https://skmtc.net/aws/apis/wickr/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/wickr/versions/71d396c2af63/schema)