AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wickr ]

batch-create-user

Description

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.

Note

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

See also: AWS API Documentation

Synopsis

  batch-create-user
--network-id <value>
--users <value>
[--client-token <value>]
[--cli-input-json <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 where users will be created.

--users (list)

A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.

(structure)

Contains the details for a single user to be created in a batch user creation request.

Note

A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.

Note

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

firstName -> (string)

The first name of the user.

lastName -> (string)

The last name of the user.

securityGroupIds -> (list)

A list of security group IDs to which the user should be assigned.

(string)

username -> (string)

The email address or username for the user. Must be unique within the network.

inviteCode -> (string)

A custom invite code for the user. If not provided, one will be generated automatically.

inviteCodeTtl -> (integer)

The time-to-live for the invite code in days. After this period, the invite code will expire.

codeValidation -> (boolean)

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

Shorthand Syntax:

firstName=string,lastName=string,securityGroupIds=string,string,username=string,inviteCode=string,inviteCodeTtl=integer,codeValidation=boolean ...

JSON Syntax:

[
  {
    "firstName": "string",
    "lastName": "string",
    "securityGroupIds": ["string", ...],
    "username": "string",
    "inviteCode": "string",
    "inviteCodeTtl": integer,
    "codeValidation": true|false
  }
  ...
]

--client-token (string)

A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without creating duplicate users.

--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.

--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

message -> (string)

A message indicating the overall result of the batch operation.

successful -> (list)

A list of user objects that were successfully created, including their assigned user IDs and invite codes.

(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.

failed -> (list)

A list of user creation attempts that failed, including error details explaining why each user could not be created.

(structure)

Contains error information for a user operation that failed in a batch user request.

field -> (string)

The field that caused the error.

reason -> (string)

A description of why the user operation failed.

userId -> (string)

The user ID associated with the failed operation.