security_groups

Creates, updates, deletes, gets or lists a security_groups resource.

Overview

Name	security_groups
Type	Resource
Id	aws.wickr.security_groups

Fields

The following fields are returned by SELECT queries:

get_security_group

Name	Datatype	Description
id	string	The unique identifier of the security group. (pattern: <code>[\S\s]*</code>)
name	string	The human-readable name of the security group. (pattern: <code>[\S\s]*</code>)
active_directory_guid	string	The GUID of the Active Directory group associated with this security group, if synchronized with LDAP. (pattern: <code>[\S\s]*</code>)
active_members	integer	The number of active user members currently in the security group.
bot_members	integer	The number of bot members currently in the security group.
is_default	boolean	Indicates whether this is the default security group for the network. Each network has only one default group.
modified	integer	The timestamp when the security group was last modified, specified in epoch seconds.
security_group_settings	object	The comprehensive configuration settings that define capabilities and restrictions for members of this security group.

list_security_groups

Name	Datatype	Description
id	string	The unique identifier of the security group. (pattern: <code>[\S\s]*</code>)
name	string	The human-readable name of the security group. (pattern: <code>[\S\s]*</code>)
active_directory_guid	string	The GUID of the Active Directory group associated with this security group, if synchronized with LDAP. (pattern: <code>[\S\s]*</code>)
active_members	integer	The number of active user members currently in the security group.
bot_members	integer	The number of bot members currently in the security group.
is_default	boolean	Indicates whether this is the default security group for the network. Each network has only one default group.
modified	integer	The timestamp when the security group was last modified, specified in epoch seconds.
security_group_settings	object	The comprehensive configuration settings that define capabilities and restrictions for members of this security group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_security_group	select	network_id, group_id, region		Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.
list_security_groups	select	network_id, region	nextToken, maxResults, sortFields, sortDirection	Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.
create_security_group	insert	network_id, region, name, securityGroupSettings	X-Client-Token	Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.
update_security_group	update	network_id, group_id, region		Updates the properties of an existing security group in a Wickr network, such as its name or settings.
delete_security_group	delete	network_id, group_id, region		Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
group_id	string	The unique identifier of the security group to delete.
network_id	string	The ID of the Wickr network from which the security group will be deleted.
region	string	AWS region (default: us-east-1)
X-Client-Token	string	A unique identifier for this request to ensure idempotency.
maxResults	integer	The maximum number of security groups to return in a single page. Valid range is 1-100. Default is 10.
nextToken	string	The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
sortDirection	string	The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
sortFields	string	The field to sort security groups by. Accepted values include 'id' and 'name'.

SELECT examples

get_security_group

Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.

SELECT
id,
name,
active_directory_guid,
active_members,
bot_members,
is_default,
modified,
security_group_settings
FROM aws.wickr.security_groups
WHERE network_id = '{{ network_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND region = '{{ region }}' -- required
;

list_security_groups

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

SELECT
id,
name,
active_directory_guid,
active_members,
bot_members,
is_default,
modified,
security_group_settings
FROM aws.wickr.security_groups
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND sortFields = '{{ sortFields }}'
AND sortDirection = '{{ sortDirection }}'
;

INSERT examples

create_security_group

Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.

INSERT INTO aws.wickr.security_groups (
name,
securityGroupSettings,
network_id,
region,
`X-Client-Token`
)
SELECT 
'{{ name }}' /* required */,
'{{ securityGroupSettings }}' /* required */,
'{{ network_id }}',
'{{ region }}',
'{{ X-Client-Token }}'
RETURNING
security_group
;

Manifest

# Description fields are for documentation purposes
- name: security_groups
props:
  - name: network_id
    value: "{{ network_id }}"
    description: Required parameter for the security_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the security_groups resource.
  - name: name
    value: "{{ name }}"
  - name: securityGroupSettings
    description: |
      Contains the security group configuration settings that can be specified when creating or updating a security group. This is a subset of SecurityGroupSettings containing only the modifiable federation and security settings.
    value:
      lockoutThreshold: {{ lockoutThreshold }}
      permittedNetworks:
        - "{{ permittedNetworks }}"
      enableGuestFederation: {{ enableGuestFederation }}
      globalFederation: {{ globalFederation }}
      federationMode: {{ federationMode }}
      enableRestrictedGlobalFederation: {{ enableRestrictedGlobalFederation }}
      permittedWickrAwsNetworks:
        - region: "{{ region }}"
          networkId: "{{ networkId }}"
      permittedWickrEnterpriseNetworks:
        - domain: "{{ domain }}"
          networkId: "{{ networkId }}"
  - name: X-Client-Token
    value: "{{ X-Client-Token }}"
    description: A unique identifier for this request to ensure idempotency.
    description: A unique identifier for this request to ensure idempotency.

UPDATE examples

update_security_group

Updates the properties of an existing security group in a Wickr network, such as its name or settings.

UPDATE aws.wickr.security_groups
SET 
name = '{{ name }}',
securityGroupSettings = '{{ securityGroupSettings }}'
WHERE 
network_id = '{{ network_id }}' --required
AND group_id = '{{ group_id }}' --required
AND region = '{{ region }}' --required
RETURNING
security_group;

DELETE examples

delete_security_group

Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.

DELETE FROM aws.wickr.security_groups
WHERE network_id = '{{ network_id }}' --required
AND group_id = '{{ group_id }}' --required
AND region = '{{ region }}' --required
;