リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/users/{userId}/mfa-devices

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`userId`	String	Required	SSO User ID SSO Userリストの照会を参照

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`encodedKey`	String	Required	OTP秘密鍵認証アプリ設定用として提供されたキーを入力 NAVERクラウドプラットフォームコンソールの Ncloud Single Sign-On > External IdP login > Users メニューのユーザーの詳細情報ページで、 [MFA Device] タブにある [追加] ボタンをクリックして確認
`otpNo`	String	Required	OTP認証番号 6桁の数字認証アプリの設定後、画面に表示された数字を入力

リクエスト例

リクエストのサンプルコードは次の通りです。

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": "******"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`が`false`の場合、表示

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "success": true
}

この記事は役に立ちましたか?

リクエスト
レスポンス