Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wickr ]

list-users¶

Description¶

Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.

Synopsis¶

  list-users
--network-id <value>
[--sort-fields <value>]
[--sort-direction <value>]
[--first-name <value>]
[--last-name <value>]
[--username <value>]
[--status <value>]
[--group-id <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options¶

--network-id (string)

The ID of the Wickr network from which to list users.

--sort-fields (string)

The fields to sort users by. Multiple fields can be specified by separating them with ‘+’. Accepted values include ‘username’, ‘firstName’, ‘lastName’, ‘status’, and ‘groupId’.

--sort-direction (string)

The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

Possible values:

ASC

DESC

--first-name (string)

Filter results to only include users with first names matching this value.

--last-name (string)

Filter results to only include users with last names matching this value.

--username (string)

Filter results to only include users with usernames matching this value.

--status (integer)

Filter results to only include users with this status (1 for pending, 2 for active).

--group-id (string)

Filter results to only include users belonging to this security group.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output¶

nextToken -> (string)

The token to use for retrieving the next page of results. If this is not present, there are no more results.

users -> (list)

A list of user objects matching the specified filters and within the current page.

(structure)

Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.

Note
codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.

userId -> (string)

The unique identifier for the user within the network.

firstName -> (string)

The first name of the user.

lastName -> (string)

The last name of the user.

username -> (string)

The email address or username of the user. For bots, this must end in ‘bot’.

securityGroups -> (list)

A list of security group IDs to which the user is assigned, determining their permissions and feature access.

(string)

isAdmin -> (boolean)

Indicates whether the user has administrator privileges in the network.

suspended -> (boolean)

Indicates whether the user is currently suspended and unable to access the network.

status -> (integer)

The current status of the user (1 for pending invitation, 2 for active).

otpEnabled -> (boolean)

Indicates whether one-time password (OTP) authentication is enabled for the user.

scimId -> (string)

The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.

type -> (string)

The descriptive type of the user account (e.g., ‘user’).

cell -> (string)

The phone number minus country code, used for cloud deployments.

countryCode -> (string)

The country code for the user’s phone number, used for cloud deployments.

challengeFailures -> (integer)

The number of failed password attempts for enterprise deployments, used for account lockout policies.

isInviteExpired -> (boolean)

Indicates whether the user’s email invitation code has expired, applicable to cloud deployments.

isUser -> (boolean)

Indicates whether this account is a user (as opposed to a bot or other account type).

inviteCode -> (string)

The invitation code for this user, used during registration to join the network.

codeValidation -> (boolean)

Indicates whether the user can be verified through a custom invite code.

uname -> (string)

The unique identifier for the user.

Table of Contents

Feedback

User Guide