API-Vertrag für Registrierungssuche

Online bearbeiten

Fast jede externe MFA-Integration muss die Fähigkeit von ISV Verify unterstützen, alle derzeit verfügbaren MFA-Faktorfunktionen für einen bestimmten Benutzer zu finden. Bei der Ausführung erwartet Verify, dass die Antwort eine Liste von JSON-Objekten enthält, wobei jedes Objekt eine MFA-Funktionalität des Benutzers identifiziert und darstellt.

Das folgende Beispiel veranschaulicht eine Beispielanfrage, die an Verify die enrollments Ressource des Echtzeit-Webhooks gesendet wird. Je nach Webhook-Konfiguration können dieselben Nutzdaten direkt an den Ziel-MFA-Provider gesendet oder in eine API-Clientanforderung umgewandelt werden, die für den Zielprovider akzeptabel ist.

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

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

Hinweis: Der /enrollments Pfad „ HTTP “ in diesem Beispiel hängt von der Webhook-Konfiguration ab.

Details zur Suchanforderung für Registrierungen

Element	Beschreibung
HTTP-Anforderung	POST
HTTP-Header - Content-Type	Der Inhaltstyp der Anforderungsnutzdaten ist immer `application/json`.
HTTP-Header - Accept	Der von den Antwortnutzdaten erwartete Inhaltstyp ist immer `application/json`.
Nutzdaten	Ein JSON-Objekt, das den Benutzer angibt, für den Registrierungen angefordert werden.
username	Obligatorisch. Der Name eines Benutzers im externen Providersystem, für das Registrierungsdaten angefordert werden.

Das folgende Beispiel zeigt die Nutzdaten einer enrollment lookup-Antwort.

[
    {
        "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>>"
    }
]

Antwortdetails für die Suche nach Registrierungen

Elemente	Beschreibung
Nutzdatentyp	Ein JSON-Array mit externen MFA-Registrierungen.
HTTP-Statuscode	Siehe „ HTTP -Status “.
`id`	Obligatorisch. Die eindeutige Kennung der angemeldeten oder registrierten MFA-Faktorfunktion des Benutzers.
`capability`	Obligatorisch. Der Wert ist eine gültige Zeichenfolge. Sie muss einer der Funktionen entsprechen, die für den MFA-Provider konfiguriert sind, der dem Webhook zugeordnet ist.
`attributes`	Obligatorisch. Die zusätzlichen Attribute, die an den öffentlichen Verify-Client zurückgegeben werden, der die Registrierungssuche ausgelöst hat. Es können weitere Attribute und Werte vorhanden sein.
`attributes.authExecutionFlow`	Obligatorisch. Informiert Verify über den `MFA pattern`, der von der Faktorfunktion unterstützt wird. Die folgenden Werte sind gültig: `validate` - Nur Muster validieren. `init_then_validate` - Validierungsmuster einleiten. `init_then_poll` - Muster "Einleiten und anschließend auf Abschluss warten". Dieses Attribut wird von Verify External MFA Runtime Challenge UI/UX und Framework verwendet, um die Laufzeitausführung zu steuern.
`attributes.deliveryAddress`	Optional. Wenn das Ausführungsmuster eine MFA-Tokenbereitstellung oder eine ähnliche Erfahrung beinhaltet, wird dieses Attribut von Verify während der MFA-Benutzerauswahl angezeigt. Dieses Muster kann die Benutzerauswahl über die MFA-Auswahl, die angeboten wird, unterstützen und informieren.
`attributes.deviceName`	Optional. Wenn das Ausführungsmuster eine MFA-Tokenübermittlungserfahrung enthält oder anderweitig eine Art separates Authentifizierungsgerät oder Token enthält, dessen Eigner der Benutzer ist, wird dieses Attribut von Verify während der MFA-Benutzerauswahl angezeigt. Dieses Muster kann die Benutzerauswahl über die MFA-Auswahl, die angeboten wird, unterstützen und informieren.