Registering an MFA device
Function
This API is used to register an MFA device for a user and to return an MFA registration address. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.
URI
POST /v1/identity-stores/{identity_store_id}/users/{user_id}/mfa-devices/register-mfa-device
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| identity_store_id | Yes | String | Globally unique ID of an identity source. |
| user_id | Yes | String | Globally unique ID of an IAM Identity Center user in the identity source. |
Request Parameters
| 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| identity_store_id | String | Globally unique ID of an identity source. |
| user_id | String | Unique user ID in an identity source. |
| work_flow | String | One-time random character required for MFA registration. |
| redirect_url | String | Redirection address after an MFA device is registered. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| request_id | String | Unique ID of a request. |
Status code: 403
| 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. |
Example Request
Registering an MFA device for a user
POST https://{hostname}/v1/identity-stores/{identity_store_id}/users/{user_id}/mfa-devices/register-mfa-device Example Response
Status code: 200
Successful
{
"identity_store_id" : "your identity store id",
"user_id" : "your user id",
"work_flow" : "random string",
"redirect_url" : "redirect url"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Successful. |
| 400 | Bad request. |
| 403 | Forbidden. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
