ジャンプ先

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

OTPの生成

投稿

/oam/services/rest/auth/api/v1/mfa/createOTP

指定されたユーザーのOTPコードを生成し、検証用のOTPコードを格納し、指定されたデリバリ・チャネルを使用して送信します。また、有効なcorrelationIdを生成するために、TOTPコードを検証する前に呼び出す必要があります。構成の詳細は、OAM管理ガイドのOracle Access Managementコンソールのアダプティブ認証プラグインの構成に関する項で確認できます

リクエスト

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

• application/json
• application/xml

本文()

OTPリクエストの作成

ルート・スキーマ: CreateOTPRequest

型: object

ソースを表示

• appName: string
  呼出し側アプリケーションを定義する名前。
• deliveryChannel: string
  ユーザーにOTPを配信するチャネル。(sms|email|totp|custom)
• email(optional): string
  OTPコードの配信に使用するユーザーの電子メール・アドレス。
• idStore(optional): string
  指定されたユーザーを検索するアイデンティティ・ストア参照。
• phone(optional): string
  OTPコードの配信に使用するユーザーの電話番号。
• sessionId(optional): string
  OTP生成に関連付けられているSessionId。
• userId: string
  OTPコードを生成するユーザーのユーザー名。

{
    "type":"object",
    "required":[
        "userId",
        "appName",
        "deliveryChannel"
    ],
    "properties":{
        "userId":{
            "description":"Username of user to generate OTP code for.",
            "type":"string"
        },
        "appName":{
            "description":"Name defining calling app.",
            "type":"string"
        },
        "deliveryChannel":{
            "description":"Channel to deliver OTP to user. (sms|email|totp|custom)",
            "type":"string"
        },
        "email":{
            "description":"Email address of user to use for delivery of OTP code.",
            "type":"string"
        },
        "phone":{
            "description":"Phone number of user to use for delivery of OTP code.",
            "type":"string"
        },
        "sessionId":{
            "description":"SessionId associated with OTP generation.",
            "type":"string"
        },
        "idStore":{
            "description":"Identity Store Reference to find supplied user.",
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

成功

本文()

ルート・スキーマ: CreateOTPResponse

型: object

ソースを表示

• correlationId(optional): string
  生成されたOTPコードの一意の識別子。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  配信チャネルが"custom"である場合にエラーを示すまたはOTPコードを含むマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

401 レスポンス

未認可

404 レスポンス

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

422 レスポンス

処理不能なエンティティ

本文()

ルート・スキーマ: CreateOTPResponse

型: object

ソースを表示

• correlationId(optional): string
  生成されたOTPコードの一意の識別子。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  配信チャネルが"custom"である場合にエラーを示すまたはOTPコードを含むマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

424 レスポンス

依存性のエラーが発生

本文()

ルート・スキーマ: CreateOTPResponse

型: object

ソースを表示

• correlationId(optional): string
  生成されたOTPコードの一意の識別子。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  配信チャネルが"custom"である場合にエラーを示すまたはOTPコードを含むマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

500 レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: CreateOTPResponse

型: object

ソースを表示

• correlationId(optional): string
  生成されたOTPコードの一意の識別子。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  配信チャネルが"custom"である場合にエラーを示すまたはOTPコードを含むマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

先頭に戻る