Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Required |
Name of the user whose MFA device you want to deactivate. [Constraints: The value must be between 1 and 128 characters, and must match the following regular expression pattern: |
|
|
Required |
The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. [Constraints: The value must be between 9 and 256 characters, and must match the following regular expression pattern: |
|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Deactivates a multi-factor authentication device.
Learn more about multi-factor authentication at aws.amazon.com/mfa.
// Instantiate the class $iam = new AmazonIAM(); $response = $iam->deactivate_mfa_device('johndoe2', CFCredentials::get('@default')->mfa_serial); // Success? var_dump($response->isOK());Result:
bool(true)
Related Methods
Source
Method defined in services/iam.class.php | Toggle source view (8 lines) | View on GitHub