MFA確認の作成
セキュアなアカウント操作のための多要素認証確認を作成します。MFA確認は機密性の高いアクションに対する追加のセキュリティレイヤーを提供します。
リクエストパラメータ
必須 - 1フィールド必須パラメータ
`code`STRING(required)
認証アプリまたはSMSからのMFA認証コード。
追加 - 1フィールド追加パラメータ
レスポンス
200
MFA確認作成成功MFA確認が作成され、検証されました。確認は関連するアクションに使用できるようになりました。
MFA確認オブジェクトのフィールド:
object- 文字列値 "mfa_confirmation"id- MFA確認ID(mfa_*)。後続の操作に使用。location- この確認へのAPIエンドポイントパスverified- MFAコードが有効かどうかを示すブール値action- この確認の対象アクションexpires_at- 確認の有効期限タイムスタンプ(ISO 8601)created_at- 確認作成タイムスタンプ(ISO 8601)
400
不正なリクエストリクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。
一般的な原因:
- 必須のcodeパラメータが欠落
- 無効なコード形式
- 不正なMFAコード
- MFAコードの有効期限切れ
401
認証エラー認証に失敗しました。APIキーが無効または欠落しています。
一般的な原因:
- Authorizationヘッダーの欠落
- 無効なシークレットキー
- シークレットキーの代わりにパブリックキーを使用
- 不正なHTTP Basic Auth形式
404
見つかりませんアカウントのMFA設定が見つかりません。
一般的な原因:
- アカウントでMFAが有効になっていない
- アカウントにMFAが設定されていない
5xx
サーバーエラーサーバー側でエラーが発生しました。これらは稀ですが、適切に処理する必要があります。
対処方法:
- 指数バックオフでリクエストを再試行
- status.omise.coでサービスインシデントを確認
- 詳細なガイダンスはエラー処理を参照
コードサンプル
- cURL
- Ruby
- Python
- Node.js
- PHP
- Java
- C#
- Go
curl https://api.omise.co/mfa_confirmations \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "code=123456" \
-d "action=transfer_creation"
require 'omise'
Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'
mfa_confirmation = Omise::MfaConfirmation.create({
code: '123456',
action: 'transfer_creation'
})
import omise
omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'
mfa_confirmation = omise.MfaConfirmation.create(
code='123456',
action='transfer_creation'
)
const omise = require('omise')({
secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});
const mfaConfirmation = await omise.mfaConfirmations.create({
code: '123456',
action: 'transfer_creation'
});
<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');
$mfaConfirmation = OmiseMfaConfirmation::create([
'code' => '123456',
'action' => 'transfer_creation'
]);
Client client = new Client.Builder()
.secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
.build();
MfaConfirmation mfaConfirmation = client.mfaConfirmations().create()
.code("123456")
.action("transfer_creation")
.send();
var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");
var mfaConfirmation = await client.MfaConfirmations.Create(new CreateMfaConfirmationRequest
{
Code = "123456",
Action = "transfer_creation"
});
client, _ := omise.NewClient(
"pkey_test_5xuy4w91xqz7d1w9u0t",
"skey_test_5xuy4w91xqz7d1w9u0t",
)
mfaConfirmation, _ := client.MfaConfirmations().Create(&operations.CreateMfaConfirmation{
Code: "123456",
Action: "transfer_creation",
})
エラーと結果コード
一般的なエラーコード
| コード | 説明 | 解決方法 |
|---|---|---|
bad_request | パラメータの欠落または無効 | コード形式と必須フィールドを確認 |
authentication_failure | 無効なAPIキー | シークレットキーが正しいことを確認 |
invalid_mfa_code | MFAコードが不正 | 認証アプリから正しいコードを入力 |
expired_mfa_code | MFAコードの有効期限切れ | 新しいコードをリクエストして再試行 |
mfa_not_enabled | MFAが設定されていない | まずアカウントでMFAを有効化 |
MFA確認フィールド
| フィールド | 説明 |
|---|---|
id | MFA確認ID(後続の操作に使用) |
verified | MFAが成功したかどうかを示すブール値 |
action | この確認が認可するアクション |
expires_at | 確認の有効期限 |
created_at | 確認作成タイムスタンプ |
API認証情報
試してみる
必須 - 1項目
追加 - 1項目
あなたのIP:
...読み込み中...