Skip to content

/AWS1/CL_IAM=>ENABLEMFADEVICE()

About EnableMFADevice

Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

Method Signature

IMPORTING

Required arguments:

iv_username TYPE /AWS1/IAMEXISTINGUSERNAMETYPE /AWS1/IAMEXISTINGUSERNAMETYPE

The name of the IAM user for whom you want to enable the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

iv_serialnumber TYPE /AWS1/IAMSERIALNUMBERTYPE /AWS1/IAMSERIALNUMBERTYPE

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

iv_authenticationcode1 TYPE /AWS1/IAMAUTHNTCTNCODETYPE /AWS1/IAMAUTHNTCTNCODETYPE

An authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

iv_authenticationcode2 TYPE /AWS1/IAMAUTHNTCTNCODETYPE /AWS1/IAMAUTHNTCTNCODETYPE

A subsequent authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->/aws1/if_iam~enablemfadevice(
  iv_authenticationcode1 = |string|
  iv_authenticationcode2 = |string|
  iv_serialnumber = |string|
  iv_username = |string|
).