SSO Userに MFA Deviceを追加
    • PDF

    SSO Userに MFA Deviceを追加

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    SSO Userに MFA Deviceを追加します。

    リクエスト

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

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

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    userIdStringRequiredSSO User ID

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    encodedKeyStringRequiredOTP秘密鍵
    • 認証アプリ設定用として提供されたキーを入力
    • NAVERクラウドプラットフォームコンソールの Ncloud Single Sign-On > External IdP login > Users メニューのユーザーの詳細情報ページで、 [MFA Device] タブにある [追加] ボタンをクリックして確認
    otpNoStringRequiredOTP認証番号
    • 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": "******"
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    successBoolean-API処理結果
    • true | false
      • true: 成功
      • false: 失敗
    messageString-結果メッセージ
    • successfalseの場合、表示

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

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

    レスポンス例

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

    {
        "success": true
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.