2段階認証情報の照会

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

サブアカウントの2段階認証情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/sub-accounts/{subAccountId}/mfa

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`subAccountId`	String	Required	サブアカウント ID サブアカウントリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/mfa' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`isMfaMandatory`	Boolean	-	2段階認証は必須かどうか `true` \| `false` `true`: 必須 `false`: 任意
`mfaList`	Array	-	MFAの設定情報

mfaList

mfaListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`mfaType`	String	-	2段階認証のタイプ `PHONE` \| `EMAIL` \| `OTP` \| `PASSKEY` `PHONE`: 携帯電話 `EMAIL`: メール `OTP`: NAVERクラウドプラットフォーム認証 OTP `PASSKEY`: パスキー

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

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

レスポンス例

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

{
  "isMfaMandatory": true,
  "mfaList": [
    {
      "mfaType": "EMAIL"
    },
    {
      "mfaType": "PASSKEY"
    },
    {
      "mfaType": "PHONE"
    }
  ]
}