networks

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

Overview

Name	networks
Type	Resource
Id	aws.wickr.networks

Fields

The following fields are returned by SELECT queries:

get_network

Name	Datatype	Description
access_level	string	The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities. (STANDARD, PREMIUM)
aws_account_id	string	The Amazon Web Services account ID that owns the network. (pattern: <code>[\S\s]*</code>)
encryption_key_arn	string	The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network. (pattern: <code>[\S\s]*</code>)
free_trial_expiration	string	The expiration date and time for the network's free trial period, if applicable. (pattern: <code>[\S\s]*</code>)
migration_state	integer	The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).
network_arn	string	The Amazon Resource Name (ARN) of the network. (pattern: <code>[\S\s]*</code>)
network_id	string	The unique identifier of the network. (pattern: <code>[0-9]{8}</code>)
network_name	string	The name of the network. (pattern: <code>[\S\s]*</code>)
standing	integer	The current standing or status of the network.

list_networks

Name	Datatype	Description
access_level	string	The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities. (STANDARD, PREMIUM)
aws_account_id	string	The Amazon Web Services account ID that owns the network. (pattern: <code>[\S\s]*</code>)
encryption_key_arn	string	The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network. (pattern: <code>[\S\s]*</code>)
free_trial_expiration	string	The expiration date and time for the network's free trial period, if applicable. (pattern: <code>[\S\s]*</code>)
migration_state	integer	The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).
network_arn	string	The Amazon Resource Name (ARN) of the network. (pattern: <code>[\S\s]*</code>)
network_id	string	The unique identifier of the network. (pattern: <code>[0-9]{8}</code>)
network_name	string	The name of the network. (pattern: <code>[\S\s]*</code>)
standing	integer	The current standing or status of the network.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network	select	network_id, region		Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.
list_networks	select	region	maxResults, sortFields, sortDirection, nextToken	Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.
register_oidc_config	insert	network_id, region, companyId, issuer, scopes		Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.
register_oidc_config_test	insert	network_id, region, issuer, scopes		Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.
create_network	insert	region, networkName, accessLevel		Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.
update_data_retention	update	network_id, region, actionType		Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.
update_network	update	network_id, region, networkName	X-Client-Token	Updates the properties of an existing Wickr network, such as its name or encryption key configuration.
delete_network	delete	network_id, region	X-Client-Token	Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.
batch_create_user	exec	network_id, region, users	X-Client-Token	Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.
batch_delete_user	exec	network_id, region, userIds	X-Client-Token	Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.
batch_lookup_user_uname	exec	network_id, region, unames	X-Client-Token	Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.
batch_reinvite_user	exec	network_id, region, userIds	X-Client-Token	Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.
batch_reset_devices_for_user	exec	network_id, user_id, region, appIds	X-Client-Token	Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.
batch_toggle_user_suspend_status	exec	network_id, suspend, region, userIds	X-Client-Token	Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.

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
network_id	string	The ID of the Wickr network where users will be suspended or unsuspended.
region	string	AWS region (default: us-east-1)
suspend	boolean	A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.
user_id	string	The ID of the user whose devices will be reset.
X-Client-Token	string	A unique identifier for this request to ensure idempotency.
maxResults	integer	The maximum number of networks 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 networks by. Accepted values are 'networkId' and 'networkName'. Default is 'networkId'.

SELECT examples

get_network

Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.

SELECT
access_level,
aws_account_id,
encryption_key_arn,
free_trial_expiration,
migration_state,
network_arn,
network_id,
network_name,
standing
FROM aws.wickr.networks
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
;

list_networks

Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.

SELECT
access_level,
aws_account_id,
encryption_key_arn,
free_trial_expiration,
migration_state,
network_arn,
network_id,
network_name,
standing
FROM aws.wickr.networks
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND sortFields = '{{ sortFields }}'
AND sortDirection = '{{ sortDirection }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

register_oidc_config

Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.

INSERT INTO aws.wickr.networks (
companyId,
customUsername,
extraAuthParams,
issuer,
scopes,
secret,
ssoTokenBufferMinutes,
userId,
network_id,
region
)
SELECT 
'{{ companyId }}' /* required */,
'{{ customUsername }}',
'{{ extraAuthParams }}',
'{{ issuer }}' /* required */,
'{{ scopes }}' /* required */,
'{{ secret }}',
{{ ssoTokenBufferMinutes }},
'{{ userId }}',
'{{ network_id }}',
'{{ region }}'
RETURNING
application_id,
application_name,
ca_certificate,
client_id,
client_secret,
company_id,
custom_username,
extra_auth_params,
issuer,
redirect_url,
scopes,
secret,
sso_token_buffer_minutes,
user_id
;

register_oidc_config_test

Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.

INSERT INTO aws.wickr.networks (
extraAuthParams,
issuer,
scopes,
certificate,
network_id,
region
)
SELECT 
'{{ extraAuthParams }}',
'{{ issuer }}' /* required */,
'{{ scopes }}' /* required */,
'{{ certificate }}',
'{{ network_id }}',
'{{ region }}'
RETURNING
authorization_endpoint,
end_session_endpoint,
grant_types_supported,
issuer,
logout_endpoint,
microsoft_multi_refresh_token,
response_types_supported,
revocation_endpoint,
scopes_supported,
token_endpoint,
token_endpoint_auth_methods_supported,
userinfo_endpoint
;

create_network

Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.

INSERT INTO aws.wickr.networks (
networkName,
accessLevel,
enablePremiumFreeTrial,
encryptionKeyArn,
region
)
SELECT 
'{{ networkName }}' /* required */,
'{{ accessLevel }}' /* required */,
{{ enablePremiumFreeTrial }},
'{{ encryptionKeyArn }}',
'{{ region }}'
RETURNING
encryption_key_arn,
network_id,
network_name
;

Manifest

# Description fields are for documentation purposes
- name: networks
props:
  - name: network_id
    value: "{{ network_id }}"
    description: Required parameter for the networks resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the networks resource.
  - name: companyId
    value: "{{ companyId }}"
  - name: customUsername
    value: "{{ customUsername }}"
  - name: extraAuthParams
    value: "{{ extraAuthParams }}"
  - name: issuer
    value: "{{ issuer }}"
  - name: scopes
    value: "{{ scopes }}"
  - name: secret
    value: "{{ secret }}"
  - name: ssoTokenBufferMinutes
    value: {{ ssoTokenBufferMinutes }}
  - name: userId
    value: "{{ userId }}"
  - name: certificate
    value: "{{ certificate }}"
  - name: networkName
    value: "{{ networkName }}"
  - name: accessLevel
    value: "{{ accessLevel }}"
    valid_values: ['STANDARD', 'PREMIUM']
  - name: enablePremiumFreeTrial
    value: {{ enablePremiumFreeTrial }}
  - name: encryptionKeyArn
    value: "{{ encryptionKeyArn }}"

UPDATE examples

update_data_retention

Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.

UPDATE aws.wickr.networks
SET 
actionType = '{{ actionType }}'
WHERE 
network_id = '{{ network_id }}' --required
AND region = '{{ region }}' --required
AND actionType = '{{ actionType }}' --required
RETURNING
message;

update_network

Updates the properties of an existing Wickr network, such as its name or encryption key configuration.

UPDATE aws.wickr.networks
SET 
networkName = '{{ networkName }}',
encryptionKeyArn = '{{ encryptionKeyArn }}'
WHERE 
network_id = '{{ network_id }}' --required
AND region = '{{ region }}' --required
AND networkName = '{{ networkName }}' --required
AND `X-Client-Token` = '{{ X-Client-Token}}'
RETURNING
message;

DELETE examples

delete_network

Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.

DELETE FROM aws.wickr.networks
WHERE network_id = '{{ network_id }}' --required
AND region = '{{ region }}' --required
AND `X-Client-Token` = '{{ X-Client-Token }}'
;

Lifecycle Methods

batch_create_user

Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

EXEC aws.wickr.networks.batch_create_user 
@network_id='{{ network_id }}' --required, 
@region='{{ region }}' --required, 
@X-Client-Token='{{ X-Client-Token }}' 
@@json=
'{
"users": "{{ users }}"
}'
;

batch_delete_user

Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.

EXEC aws.wickr.networks.batch_delete_user 
@network_id='{{ network_id }}' --required, 
@region='{{ region }}' --required, 
@X-Client-Token='{{ X-Client-Token }}' 
@@json=
'{
"userIds": "{{ userIds }}"
}'
;

batch_lookup_user_uname

Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.

EXEC aws.wickr.networks.batch_lookup_user_uname 
@network_id='{{ network_id }}' --required, 
@region='{{ region }}' --required, 
@X-Client-Token='{{ X-Client-Token }}' 
@@json=
'{
"unames": "{{ unames }}"
}'
;

batch_reinvite_user

Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.

EXEC aws.wickr.networks.batch_reinvite_user 
@network_id='{{ network_id }}' --required, 
@region='{{ region }}' --required, 
@X-Client-Token='{{ X-Client-Token }}' 
@@json=
'{
"userIds": "{{ userIds }}"
}'
;

batch_reset_devices_for_user

Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.

EXEC aws.wickr.networks.batch_reset_devices_for_user 
@network_id='{{ network_id }}' --required, 
@user_id='{{ user_id }}' --required, 
@region='{{ region }}' --required, 
@X-Client-Token='{{ X-Client-Token }}' 
@@json=
'{
"appIds": "{{ appIds }}"
}'
;

batch_toggle_user_suspend_status

Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.

EXEC aws.wickr.networks.batch_toggle_user_suspend_status 
@network_id='{{ network_id }}' --required, 
@suspend='{{ suspend }}' --required, 
@region='{{ region }}' --required, 
@X-Client-Token='{{ X-Client-Token }}' 
@@json=
'{
"userIds": "{{ userIds }}"
}'
;