Configuring MFA Management

Function

This API is used to configure MFA management. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/instances/{instance_id}/mfa-devices/management-settings

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Globally unique ID of an IAM Identity Center instance.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
identity_store_id	Yes	String	Globally unique ID of the identity source associated with an IAM Identity Center instance.
user_permission	Yes	String	Action allowed for users to manage MFA.

Response Parameters

Status code: 200

Successful

Status code: 400

**Table 4** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.

Status code: 403

**Table 5** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.
encoded_authorization_message	String	Encrypted error message.

Status code: 404

**Table 6** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.

Example Request

Configuring MFA management

POST https://{hostname}/v1/instances/{instance_id}/mfa-devices/management-settings

{
  "identity_store_id" : "d-xxxxxxx",
  "user_permission" : "READ_ACTIONS"
}