ジャンプ先

• リクエスト
• レスポンス

ユーザーが指定した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: string
  OTPの配信に使用されるチャネル。TOTPを検証する場合のみ必須です。
• idStore: string
  指定されたユーザーを検索するアイデンティティ・ストア参照。
• otpCode(必須): string
  検証するユーザーが入力したOTPコード。
• sessionId: string
  OTP生成に関連付けられているSessionId。
• userId(必須): string
  OTPコードを生成するユーザーのユーザー名。

{
    "type":"object",
    "required":[
        "userId",
        "correlationId",
        "otpCode",
        "appName"
    ],
    "properties":{
        "userId":{
            "description":"Username of user to generate OTP code for.",
            "type":"string"
        },
        "correlationId":{
            "description":"CorrelationId returned by createOTP api.",
            "type":"string"
        },
        "otpCode":{
            "description":"User entered otp code to be validated.",
            "type":"string"
        },
        "appName":{
            "description":"Name defining calling app.",
            "type":"string"
        },
        "sessionId":{
            "description":"SessionId associated with OTP generation.",
            "type":"string"
        },
        "deliveryChannel":{
            "description":"Channel used for delivery of OTP. Only required if validating TOTP.",
            "type":"string"
        },
        "idStore":{
            "description":"Identity Store Reference to find supplied user.",
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

成功

本文()

ルート・スキーマ: ValidateOTPResponse

型: object

ソースを表示

• message: string
  エラーを説明するメッセージ(存在する場合)。
• minorCode: string
  エラー詳細を示すマイナー・コード。
• resultCode: string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

401 レスポンス

未認可

404 レスポンス

リクエスト・エンティティが見つからない

422 レスポンス

処理不能なエンティティ

本文()

ルート・スキーマ: ValidateOTPResponse

型: object

ソースを表示

• message: string
  エラーを説明するメッセージ(存在する場合)。
• minorCode: string
  エラー詳細を示すマイナー・コード。
• resultCode: string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

424 レスポンス

依存性のエラーが発生

本文()

ルート・スキーマ: ValidateOTPResponse

型: object

ソースを表示

• message: string
  エラーを説明するメッセージ(存在する場合)。
• minorCode: string
  エラー詳細を示すマイナー・コード。
• resultCode: string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

500 レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: ValidateOTPResponse

型: object

ソースを表示

• message: string
  エラーを説明するメッセージ(存在する場合)。
• minorCode: string
  エラー詳細を示すマイナー・コード。
• resultCode: string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

先頭に戻る