Konfigurieren der REST-API-Endpunktkonnektivität
Um die Konnektivität zwischen Client-Apps und dem REST-API-Endpunkt des
BlackBerry 2FA
-Servers zu konfigurieren, müssen Sie Ihre Client-Anwendungen so konfigurieren, dass sie den BlackBerry 2FA
-Server als vertrauenswürdig behandeln.Die Client-Apps werden über die HTTP-Standardauthentifizierung (Benutzername und Kennwort) authentifiziert, die in der Anforderung als Kopfzeilen gesendet werden. Der REST-API-Endpunkt wird durch eine vom Server authentifizierte HTTPS geschützt (https://
<Hostname>
:<Port>
/<Präfix>
/). Der Standardport lautet 5443, das Standardpräfix „rest“. Auf dem Endpunkt werden folgende REST-Anforderungen unterstützt:
Pfad | Typ | Beschreibung | Notizen |
---|---|---|---|
/ <Präfix> /twofactor | POST | Zwei-Faktor-Authentifizierungsanforderung |
Die Anforderungsnachricht wird per HTTP POST gesendet und als JSON formatiert. Sie enthält folgende Parameter:
Parameter | Typ | Beschreibung | Notizen |
---|---|---|---|
username | Zeichenfolge | Benutzername | |
-Kennwort | Zeichenfolge | Benutzerkennwort, oder Einmalkennwort und Benutzerkennwort | Optional, abhängig von der Richtlinie |
policy | Ganze Zahl | Authentifizierungsoption:
| |
oneTimePassword | Zeichenfolge | Einmalkennwort | Optional |
messageTitle | Zeichenfolge | Dialog „Titeltext“ | Optional |
message | Zeichenfolge | Dialog „Nachrichtentext“ | Optional |
confirmButtonText | Zeichenfolge | Dialog „Schaltflächentext bestätigen“ | Optional |
declineButtonText | Zeichenfolge | Dialog „Schaltflächentext verwerfen“ | Optional |
timeout | Ganze Zahl | Dialog „Timeout (Sekunden)“ | Optional |
Der Text der Antwortnachricht wird als JSON mit folgenden Parametern formatiert:
Parameter | Typ | Beschreibung | Notizen |
---|---|---|---|
info | Zeichenfolge | Informationsnachricht |
Die Antwortnachricht enthält außerdem folgende HTTP-Statuscodes:
Status | Beschreibung | Notizen |
---|---|---|
200 | OK | Authentifizierung erfolgreich |
400 | Ungültige Anforderung | Ungültige Parameter |
401 | Nicht autorisiert | Authentifizierung fehlgeschlagen |
403 | Abgelehnt | Vom Benutzer abgelehnte Authentifizierung |
500 | Interner Serverfehler | Interner Fehler |