AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Identity Store CreateUser API operation.

Syntax

New-IDSUser
-IdentityStoreId <String>
-Address <Address[]>
-Birthdate <String>
-DisplayName <String>
-Email <Email[]>
-Extension <Hashtable>
-Name_FamilyName <String>
-Name_Formatted <String>
-Name_GivenName <String>
-Name_HonorificPrefix <String>
-Name_HonorificSuffix <String>
-Locale <String>
-Name_MiddleName <String>
-NickName <String>
-PhoneNumber <PhoneNumber[]>
-Photo <Photo[]>
-PreferredLanguage <String>
-ProfileUrl <String>
-Role <Role[]>
-Timezone <String>
-Title <String>
-UserName <String>
-UserType <String>
-Website <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonIdentityStoreConfig>

Description

Creates a user within the specified identity store.

Parameters

-Address <Address[]>
A list of Address objects containing addresses associated with the user. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAddresses
-Birthdate <String>
The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonIdentityStoreConfig>
Amazon.PowerShell.Cmdlets.IDS.AmazonIdentityStoreClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Email <Email[]>
A list of Email objects containing email addresses associated with the user. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEmails
-Extension <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExtensions
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdentityStoreId <String>
The globally unique identifier for the identity store.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Locale <String>
A string containing the geographical region or location of the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name_FamilyName <String>
The family name of the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name_Formatted <String>
A string containing a formatted version of the name for display.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name_GivenName <String>
The given name of the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name_HonorificPrefix <String>
The honorific prefix of the user. For example, "Dr."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name_HonorificSuffix <String>
The honorific suffix of the user. For example, "M.D."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name_MiddleName <String>
The middle name of the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NickName <String>
A string containing an alternate name for the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PhoneNumber <PhoneNumber[]>
A list of PhoneNumber objects containing phone numbers associated with the user. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPhoneNumbers
-Photo <Photo[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPhotos
-PreferredLanguage <String>
A string containing the preferred language of the user. For example, "American English" or "en-us."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProfileUrl <String>
A string containing a URL that might be associated with the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Role <Role[]>
A list of Role objects containing roles associated with the user. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRoles
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'UserId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.CreateUserResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.CreateUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Timezone <String>
A string containing the time zone of the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserName <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserType <String>
A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Website <String>
The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.IdentityStore.Model.CreateUserResponse
This cmdlet returns a System.String object. The service call response (type Amazon.IdentityStore.Model.CreateUserResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z