create-user¶
Description¶
Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is “ACTIVE”. New users can access Amazon WorkDocs.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-user
[--organization-id <value>]
--username <value>
[--email-address <value>]
--given-name <value>
--surname <value>
--password <value>
[--time-zone-id <value>]
[--storage-rule <value>]
[--authentication-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--organization-id (string)
The ID of the organization.
--username (string)
The login name of the user.
--email-address (string)
The email address of the user.
--given-name (string)
The given name of the user.
--surname (string)
The surname of the user.
--password (string)
The password of the user.
--time-zone-id (string)
The time zone ID of the user.
--storage-rule (structure)
The amount of storage for the user.
StorageAllocatedInBytes -> (long)
The amount of storage allocated, in bytes.
StorageType -> (string)
The type of storage.
Shorthand Syntax:
StorageAllocatedInBytes=long,StorageType=string
JSON Syntax:
{
"StorageAllocatedInBytes": long,
"StorageType": "UNLIMITED"|"QUOTA"
}
--authentication-token (string)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
--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.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a new user
This example creates a new user in a Simple AD or Microsoft AD directory.
Command:
aws workdocs create-user --organization-id d-926726012c --username exampleUser2 --email-address exampleUser2@site.awsapps.com --given-name example2Name --surname example2Surname --password examplePa$$w0rd
Output:
{
"User": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Username": "exampleUser2",
"EmailAddress": "exampleUser2@site.awsapps.com",
"GivenName": "example2Name",
"Surname": "example2Surname",
"OrganizationId": "d-926726012c",
"RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390",
"RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff",
"Status": "ACTIVE",
"Type": "MINIMALUSER",
"CreatedTimestamp": 1535478836.584,
"ModifiedTimestamp": 1535478836.584,
"Storage": {
"StorageUtilizedInBytes": 0,
"StorageRule": {
"StorageAllocatedInBytes": 0,
"StorageType": "QUOTA"
}
}
}
}
Output¶
User -> (structure)
The user information.
Id -> (string)
The ID of the user.
Username -> (string)
The login name of the user.
EmailAddress -> (string)
The email address of the user.
GivenName -> (string)
The given name of the user.
Surname -> (string)
The surname of the user.
OrganizationId -> (string)
The ID of the organization.
RootFolderId -> (string)
The ID of the root folder.
RecycleBinFolderId -> (string)
The ID of the recycle bin folder.
Status -> (string)
The status of the user.
Type -> (string)
The type of user.
CreatedTimestamp -> (timestamp)
The time when the user was created.
ModifiedTimestamp -> (timestamp)
The time when the user was modified.
TimeZoneId -> (string)
The time zone ID of the user.
Locale -> (string)
The locale of the user.
Storage -> (structure)
The storage for the user.
StorageUtilizedInBytes -> (long)
The amount of storage used, in bytes.
StorageRule -> (structure)
The storage for a user.
StorageAllocatedInBytes -> (long)
The amount of storage allocated, in bytes.
StorageType -> (string)
The type of storage.