deactivate_mfa_device ( $user_name, $serial_number, $opt )

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

$user_name

string

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: [\w+=,.@-]*]

$serial_number

string

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: [\w+=/:,.@-]*]

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

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

public function deactivate_mfa_device($user_name, $serial_number, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['UserName'] = $user_name;
    $opt['SerialNumber'] = $serial_number;
    
    return $this->authenticate('DeactivateMFADevice', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback