AWS CLI Command Reference

[ 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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--network-id (string) [required]

The ID of the Wickr network where users will be created.

Constraints:

  • min: 8
  • max: 8
  • pattern: [0-9]{8}

--users (list) [required]

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.

Constraints:

  • pattern: [\S\s]*

lastName -> (string)

The last name of the user.

Constraints:

  • pattern: [\S\s]*

securityGroupIds -> (list) [required]

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

(string)

Constraints:

  • pattern: [\S]+

username -> (string) [required]

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

Constraints:

  • pattern: [\S\s]*

inviteCode -> (string)

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

Constraints:

  • pattern: [\S\s]*

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.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9-_:]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

message -> (string)

A message indicating the overall result of the batch operation.

Constraints:

  • pattern: [\S\s]*

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.

Constraints:

  • min: 1
  • max: 10
  • pattern: [0-9]+

firstName -> (string)

The first name of the user.

Constraints:

  • pattern: [\S\s]*

lastName -> (string)

The last name of the user.

Constraints:

  • pattern: [\S\s]*

username -> (string)

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

Constraints:

  • pattern: [\S\s]*

securityGroups -> (list)

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

(string)

Constraints:

  • pattern: [\S]+

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.

Constraints:

  • pattern: [\S\s]*

type -> (string)

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

Constraints:

  • pattern: [\S\s]*

cell -> (string)

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

Constraints:

  • pattern: [\S\s]*

countryCode -> (string)

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

Constraints:

  • pattern: [\S\s]*

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.

Constraints:

  • pattern: [\S\s]*

codeValidation -> (boolean)

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

uname -> (string)

The unique identifier for the user.

Constraints:

  • pattern: [\S\s]*

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.

Constraints:

  • pattern: [\S\s]*

reason -> (string)

A description of why the user operation failed.

Constraints:

  • pattern: [\S\s]*

userId -> (string) [required]

The user ID associated with the failed operation.

Constraints:

  • min: 1
  • max: 10
  • pattern: [0-9]+
© Copyright 2025, Amazon Web Services. Created using Sphinx.