Add SSO user MFA device

Prev Next

Available in Classic and VPC

Add an MFA device to an SSO user.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/users/{userId}/mfa-devices

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
userId String Required SSO user ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
encodedKey String Required OTP secret key
  • Enter the key provided to set up the authentication app.
  • Check by clicking the [Add] button in the [MFA Device] tab from the user details page in the Ncloud Single Sign-On > External IdP login > Users menu.
otpNo String Required OTP verification number
  • 6-digit number
  • Enter the number displayed on the screen after setting the authentication app.

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/a5968927-****-****-****-28592d5ba924/mfa-devices' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "encodedKey": "****EKJGIC72****",
    "otpNo": "******"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API processing result

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The response example is as follows:

{
    "success": true
}