security_group_users

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

Overview

Name	security_group_users
Type	Resource
Id	aws.wickr.security_group_users

Fields

The following fields are returned by SELECT queries:

list_security_group_users

Name	Datatype	Description
cell	string	The phone number minus country code, used for cloud deployments. (pattern: <code>[\S\s]*</code>)
challenge_failures	integer	The number of failed password attempts for enterprise deployments, used for account lockout policies.
code_validation	boolean	Indicates whether the user can be verified through a custom invite code.
country_code	string	The country code for the user's phone number, used for cloud deployments. (pattern: <code>[\S\s]*</code>)
first_name	string	The first name of the user. (pattern: <code>[\S\s]*</code>)
invite_code	string	The invitation code for this user, used during registration to join the network. (pattern: <code>[\S\s]*</code>)
is_admin	boolean	Indicates whether the user has administrator privileges in the network.
is_invite_expired	boolean	Indicates whether the user's email invitation code has expired, applicable to cloud deployments.
is_user	boolean	Indicates whether this account is a user (as opposed to a bot or other account type).
last_name	string	The last name of the user. (pattern: <code>[\S\s]*</code>)
otp_enabled	boolean	Indicates whether one-time password (OTP) authentication is enabled for the user.
scim_id	string	The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used. (pattern: <code>[\S\s]*</code>)
security_groups	array	A list of security group IDs to which the user is assigned, determining their permissions and feature access.
status	integer	The current status of the user (1 for pending invitation, 2 for active).
suspended	boolean	Indicates whether the user is currently suspended and unable to access the network.
type_	string	The descriptive type of the user account (e.g., 'user'). (pattern: <code>[\S\s]*</code>)
uname	string	The unique identifier for the user. (pattern: <code>[\S\s]*</code>)
user_id	string	The unique identifier for the user within the network. (pattern: <code>[0-9]+</code>)
username	string	The email address or username of the user. For bots, this must end in 'bot'. (pattern: <code>[\S\s]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_security_group_users	select	network_id, group_id, region	nextToken, maxResults, sortFields, sortDirection	Retrieves a paginated list of users who belong to a specific security group in a Wickr network.

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 whose users will be listed.
network_id	string	The ID of the Wickr network containing the security group.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of users 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 users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', and 'lastName'.

SELECT examples

list_security_group_users

Retrieves a paginated list of users who belong to a specific security group in a Wickr network.

SELECT
cell,
challenge_failures,
code_validation,
country_code,
first_name,
invite_code,
is_admin,
is_invite_expired,
is_user,
last_name,
otp_enabled,
scim_id,
security_groups,
status,
suspended,
type_,
uname,
user_id,
username
FROM aws.wickr.security_group_users
WHERE network_id = '{{ network_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND sortFields = '{{ sortFields }}'
AND sortDirection = '{{ sortDirection }}'
;