ユーザーが指定したOTP/TOTPコードの検証
投稿
/oam/services/rest/auth/api/v1/mfa/validateOTP
createOTP APIのコールで生成された格納されているコードに対して、ユーザーが指定したOTP/TOTPコードを検証します。構成の詳細は、OAM管理ガイドのOracle Access Managementコンソールのアダプティブ認証プラグインの構成に関する項で確認できます
リクエスト
サポートされているメディア・タイプ
- application/json
- application/xml
OTPリクエストの検証
ルート・スキーマ: ValidateOTPRequest
型:
ソースを表示
object
- appName: string
呼出し側アプリケーションを定義する名前。
- correlationId: string
createOTP APIが返すCorrelationId。
- deliveryChannel(optional): string
OTPの配信に使用されるチャネル。TOTPを検証する場合のみ必須です。
- idStore(optional): string
指定されたユーザーを検索するアイデンティティ・ストア参照。
- otpCode: string
検証するユーザーが入力したOTPコード。
- sessionId(optional): string
OTP生成に関連付けられているSessionId。
- userId: string
OTPコードを生成するユーザーのユーザー名。
レスポンス
サポートされているメディア・タイプ
- application/json
- application/xml
200 レスポンス
成功
ルート・スキーマ: ValidateOTPResponse
型:
ソースを表示
object
- message(optional): string
エラーを説明するメッセージ(存在する場合)。
- minorCode(optional): string
エラー詳細を示すマイナー・コード。
- resultCode(optional): string
成功(0)またはエラーを示すレスポンス・コード。
401 レスポンス
未認可
404 レスポンス
リクエスト・エンティティが見つからない
422 レスポンス
処理不能なエンティティ
ルート・スキーマ: ValidateOTPResponse
型:
ソースを表示
object
- message(optional): string
エラーを説明するメッセージ(存在する場合)。
- minorCode(optional): string
エラー詳細を示すマイナー・コード。
- resultCode(optional): string
成功(0)またはエラーを示すレスポンス・コード。
424 レスポンス
依存性のエラーが発生
ルート・スキーマ: ValidateOTPResponse
型:
ソースを表示
object
- message(optional): string
エラーを説明するメッセージ(存在する場合)。
- minorCode(optional): string
エラー詳細を示すマイナー・コード。
- resultCode(optional): string
成功(0)またはエラーを示すレスポンス・コード。
500 レスポンス
内部サーバー・エラー
ルート・スキーマ: ValidateOTPResponse
型:
ソースを表示
object
- message(optional): string
エラーを説明するメッセージ(存在する場合)。
- minorCode(optional): string
エラー詳細を示すマイナー・コード。
- resultCode(optional): string
成功(0)またはエラーを示すレスポンス・コード。