User
New-IAMUser
Synopsis
Create a user.
Syntax
New-IAMUser [-Body] <Object> [-SendEmail] [[-EdgeRCFile] <String>] [[-Section] <String>]
[[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Creates a user or clones an existing user's role assignments. Optionally, you can send a randomly generated one-time use password to the new user with the -SendEmail
switch parameter.
If you send an email with the password directly to the user, the response for this operation doesn't include that password. If you don't send this email, the password is included in the response.
Parameters
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey
to list the account switch keys available to you.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Body
Request body, either as a PSCustomObject
or string. This parameter supports pipelining.
Type: Object
Parameter Sets: (All)
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SendEmail
Sends a one-time password to the new user.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug
, -ErrorAction
, -ErrorVariable
, -InformationAction
, -InformationVariable
, -OutVariable
, -OutBuffer
, -PipelineVariable
, -Verbose
, -WarningAction
, and -WarningVariable
. For more information, see about_CommonParameters.
Inputs
System.Object
Outputs
System.Object
Related links
Updated 6 days ago