Configuration de la connectivité du point de terminaison d'API REST
Pour configurer la connectivité entre les applications clientes et le point de terminaison d'API REST du serveur
BlackBerry 2FA
, vous devez configurer vos applications clientes afin qu'elles approuvent le serveur BlackBerry 2FA
.Les applications clientes sont authentifiées à l'aide d'une authentification HTTP de base (nom d'utilisateur et mot de passe, qui sont envoyés en tant qu'en-têtes dans la demande). Le point de terminaison d'API REST est protégé à l'aide de l'élément HTTPS authentifié par le serveur (https://
<nom d'hôte>
:<port>
/<préfixe>
/). Le port par défaut est 5443 et le préfixe par défaut est « rest ». Les demandes REST suivantes sont prises en charge sur le point de terminaison :
Chemin d'accès | Type | Description | Notes |
---|---|---|---|
/ <préfixe> /twofactor | POST | Demande d'authentification à deux facteurs |
Le message de demande est envoyé à l'aide d'une requête HTTP POST et est au format JSON, avec les paramètres suivants :
Paramètre | Type | Description | Notes |
---|---|---|---|
username | Chaine | Nom d'utilisateur | |
Mot de passe | Chaine | Mot de passe utilisateur, ou mot de passe à usage unique et mot de passe utilisateur | Facultatif, en fonction de la stratégie |
policy | Nombre entier | Option d'authentification :
| |
oneTimePassword | Chaine | Mot de passe à usage unique | Facultative |
messageTitle | Chaine | Texte du titre de la boite de dialogue | Facultative |
message | Chaine | Texte du message de la boite de dialogue | Facultative |
confirmButtonText | Chaine | Texte du bouton de confirmation de la boite de dialogue | Facultative |
declineButtonText | Chaine | Texte du bouton de refus de la boite de dialogue | Facultative |
timeout | Nombre entier | Délai d'expiration de la boite de dialogue (secondes) | Facultative |
Le corps du message de réponse est au format JSON, avec le paramètre suivant :
Paramètre | Type | Description | Notes |
---|---|---|---|
info | Chaine | Message d'information |
Le message de réponse contient également les codes d'état HTTP suivants :
État | Description | Notes |
---|---|---|
200 | OK | Authentification réussie |
400 | Demande incorrecte | Paramètres non valides |
401 | Non autorisé | Échec de l'authentification |
403 | Refusé | Authentification refusée par l'utilisateur |
500 | Erreur de serveur interne | Erreur interne |