登録ルックアップ API 規約

オンラインで編集

ほとんどすべての外部 MFA 統合は、ISV Verify の機能をサポートして、特定のユーザーに対する現在使用可能なすべての MFA 要素機能を検出する必要があります。実行時に、Verify は応答に JSON オブジェクトのリストが含まれ、各オブジェクトがユーザーの MFA 機能を識別して表していることを予期しています。

以下に、が Verify リアルタイムWebhookのリソース enrollments に対して送信するリクエストの例を示します。 Webhook 構成に応じて、この同じペイロードをターゲット MFA プロバイダーに直接送信することも、ターゲット・プロバイダーが受け入れ可能な API クライアント要求に変換することもできます。

POST '/enrollments' \
'Content-Type: application/json' \
'Accept: application/json' \

{
    "username": "<<external MFA username>>"
}

注：この例にある「 HTTP 」というパスは /enrollments 、Webhookの設定によって異なります。

登録ルックアップ要求の詳細

エレメント	説明
HTTP 要求	POST
HTTP ヘッダー - Content-Type	要求ペイロードのコンテンツ・タイプは、常に `application/json` です。
HTTP ヘッダー - Accept	応答ペイロードの予期されるコンテンツ・タイプは、常に `application/json` です。
Payload	登録が要求されているユーザーを識別する JSON オブジェクト。
username	必須。登録データが要求される外部プロバイダー・システム内のユーザーの名前。

以下のサンプルは、enrollment lookup 応答ペイロードの例です。

[
    {
        "attributes": {
            "authExecutionFlow": "init_then_poll",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. push>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "init_then_validate",
            "deliveryAddress": "<<e.g. phone number or email address>>",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. smsotp>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "validate",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. totp>>",
        "id": "<<factor or device identifier from external provider>>"
    }
]

登録ルックアップ応答の詳細

エレメント	説明
ペイロード・タイプ	外部 MFA の登録の JSON 配列。
HTTP 状況コード	「 HTTP 」のステータスを参照してください。
`id`	必須。 MFA 要素機能に登録済みユーザーの固有 ID。
`capability`	必須。値は有効な文字ストリングです。これは、Webhook に関連付けられている MFA プロバイダー用に構成されている機能の 1 つと一致している必要があります。
`attributes`	必須。登録のルックアップをトリガーしたパブリック Verify クライアントに返される追加の属性。さらに多くの属性と値が存在する場合があります。
`attributes.authExecutionFlow`	必須。要素機能によってサポートされる `MFA pattern` を Verify に通知します。有効値には以下が含まれます。 `validate` - パターンのみを検証します。 `init_then_validate` - 検証パターンを開始します。 `init_then_poll` - 開始してから、完了パターンを待機します。この属性は、Verify 外部 MFA ランタイム・チャレンジ UI/UX およびフレームワークによって、ランタイム実行を駆動するために使用されます。
`attributes.deliveryAddress`	オプション。実行パターンに MFA トークン配信または類似のエクスペリエンスが含まれている場合、この属性は、MFA ユーザー選択時に Verify によって表示されます。このパターンは、提供されている MFA 選択に関して、ユーザーの選択を支援し、通知することができます。
`attributes.deviceName`	オプション。実行パターンに MFA トークン配信エクスペリエンスが含まれている場合、またはユーザーが所有する何らかの別個の認証デバイスまたはトークンが含まれている場合、この属性は MFA ユーザー選択時に Verify によって表示されます。このパターンは、提供されている MFA 選択に関して、ユーザーの選択を支援し、通知することができます。