Multi-factor authentication
Set-IAMUserMFA
Synopsis
Set a user's multi-factor authentication.
Syntax
Set-IAMUserMFA [[-UIIdentityID] <String>] [-Value] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>]
[[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Sets a specified user's multi-factor authentication to one of the values: TFA
, MFA
, or NONE
.
Your users have five login attempts with MFA or 2FA before their account is locked. If their account is locked, run the Reset-IAMUserMFA
operation to unlock it.
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
RequiredFalse
Position4
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position2
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position3
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-UIIdentityID
Unique identifier for each user. To get this value, run Get-IAMUser
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position0
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-Value
A user's multi-factor authentication method, either TFA
, MFA
, or NONE
.
Type Object
Parameter Sets (All)
Aliases
Accepted values TFA, MFA, NONE
RequiredTrue
Position1
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
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
None
Outputs
System.Object
Related links
Updated 6 months ago