AWS CLI Command Reference

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

create-user

Description

Creates a user within the specified identity store.

See also: AWS API Documentation

create-user uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  create-user
--identity-store-id <value>
[--user-name <value>]
[--name <value>]
[--display-name <value>]
[--nick-name <value>]
[--profile-url <value>]
[--emails <value>]
[--addresses <value>]
[--phone-numbers <value>]
[--user-type <value>]
[--title <value>]
[--preferred-language <value>]
[--locale <value>]
[--timezone <value>]
[--photos <value>]
[--website <value>]
[--birthdate <value>]
[--extensions <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>]

Options

--identity-store-id (string)

The globally unique identifier for the identity store.

--user-name (string)

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can’t be used for users or groups.

--name (structure)

An object containing the name of the user. When used in IAM Identity Center, this parameter is required.

Formatted -> (string)

A string containing a formatted version of the name for display.

FamilyName -> (string)

The family name of the user.

GivenName -> (string)

The given name of the user.

MiddleName -> (string)

The middle name of the user.

HonorificPrefix -> (string)

The honorific prefix of the user. For example, “Dr.”

HonorificSuffix -> (string)

The honorific suffix of the user. For example, “M.D.”

Shorthand Syntax:

Formatted=string,FamilyName=string,GivenName=string,MiddleName=string,HonorificPrefix=string,HonorificSuffix=string

JSON Syntax:

{
  "Formatted": "string",
  "FamilyName": "string",
  "GivenName": "string",
  "MiddleName": "string",
  "HonorificPrefix": "string",
  "HonorificSuffix": "string"
}

--display-name (string)

A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, “John Doe.” When used in IAM Identity Center, this parameter is required.

--nick-name (string)

A string containing an alternate name for the user.

--profile-url (string)

A string containing a URL that might be associated with the user.

--emails (list)

A list of Email objects containing email addresses associated with the user.

(structure)

The email address associated with the user.

Value -> (string)

A string containing an email address. For example, “johndoe@amazon.com.”

Type -> (string)

A string representing the type of address. For example, “Work.”

Primary -> (boolean)

A Boolean value representing whether this is the primary email address for the associated resource.

Shorthand Syntax:

Value=string,Type=string,Primary=boolean ...

JSON Syntax:

[
  {
    "Value": "string",
    "Type": "string",
    "Primary": true|false
  }
  ...
]

--addresses (list)

A list of Address objects containing addresses associated with the user.

(structure)

The address associated with the specified user.

StreetAddress -> (string)

The street of the address.

Locality -> (string)

A string of the address locality.

Region -> (string)

The region of the address.

PostalCode -> (string)

The postal code of the address.

Country -> (string)

The country of the address.

Formatted -> (string)

A string containing a formatted version of the address for display.

Type -> (string)

A string representing the type of address. For example, “Home.”

Primary -> (boolean)

A Boolean value representing whether this is the primary address for the associated resource.

Shorthand Syntax:

StreetAddress=string,Locality=string,Region=string,PostalCode=string,Country=string,Formatted=string,Type=string,Primary=boolean ...

JSON Syntax:

[
  {
    "StreetAddress": "string",
    "Locality": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string",
    "Formatted": "string",
    "Type": "string",
    "Primary": true|false
  }
  ...
]

--phone-numbers (list)

A list of PhoneNumber objects containing phone numbers associated with the user.

(structure)

The phone number associated with the user.

Value -> (string)

A string containing a phone number. For example, “8675309” or “+1 (800) 123-4567”.

Type -> (string)

A string representing the type of a phone number. For example, “Mobile.”

Primary -> (boolean)

A Boolean value representing whether this is the primary phone number for the associated resource.

Shorthand Syntax:

Value=string,Type=string,Primary=boolean ...

JSON Syntax:

[
  {
    "Value": "string",
    "Type": "string",
    "Primary": true|false
  }
  ...
]

--user-type (string)

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

--title (string)

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

--preferred-language (string)

A string containing the preferred language of the user. For example, “American English” or “en-us.”

--locale (string)

A string containing the geographical region or location of the user.

--timezone (string)

A string containing the time zone of the user.

--photos (list)

A list of photos associated with the user. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.

(structure)

Contains information about a user’s photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.

Value -> (string)

The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.

Type -> (string)

The type of photo. This field is optional and can be used to categorize different types of photos.

Display -> (string)

A human-readable description of the photo for display purposes. This optional field provides context about the photo.

Primary -> (boolean)

Specifies whether this is the user’s primary photo. Default value is false . Only one photo can be designated as primary per user.

Shorthand Syntax:

Value=string,Type=string,Display=string,Primary=boolean ...

JSON Syntax:

[
  {
    "Value": "string",
    "Type": "string",
    "Display": "string",
    "Primary": true|false
  }
  ...
]

--website (string)

The user’s personal website or blog URL. This field allows users to provide a link to their personal or professional website.

--birthdate (string)

The user’s birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.

--extensions (map)

A map with additional attribute extensions for the user. Each map key corresponds to an extension name, while map values represent extension data in Document type (not supported by Java V1, Go V1 and older versions of the CLI). aws:identitystore:enterprise is the only supported extension name.

key -> (string)

value -> (document)

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

JSON Syntax:

{"string": {...}
  ...}

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

Output

IdentityStoreId -> (string)

The globally unique identifier for the identity store.

UserId -> (string)

The identifier of the newly created user in the identity store.