Classic/VPC環境で利用できます。
SSO Userに追加した MFA Deviceを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/users/{userId}/mfa-devices |
リクエストヘッダ
Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
userId |
String | Required | SSO User ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET '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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
certType |
String | - | 認証手段
|
certInfo |
String | - | 登録情報 |
createdAt |
String | - | MFA Deviceの登録日時
|
レスポンスステータスコード
Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
[
{
"certType": "OTP",
"certInfo": "****BDWOFEP****",
"createdAt": "2025-01-17T07:41:08Z"
}
]