Authentification externe

Les administrateurs peuvent tirer parti de l'utilisation de serveurs d'authentification externes pour authentifier les utilisateurs dans MyQ. Cela s'avère particulièrement utile dans les environnements où un service d'authentification non pris en charge nativement par MyQ est utilisé.

L'authentification externe est utilisée pour la connexion sur le terminal intégré MyQ et le Desktop Client MyQ. L'interface utilisateur Web MyQ et le client mobile MyQ X nécessitent des identifiants définis dans MyQ.

Fonctionnement

Un connecteur API entre MyQ et le service d'authentification est configuré. MyQ demande l'authentification via ce connecteur, et de l'autre côté se trouve le service d'authentification lui-même, où sont stockés les utilisateurs et leurs identifiants.

L'utilisateur tente de se connecter au terminal intégré MyQ

En passant son badge
En saisissant un code PIN

La demande est envoyée au connecteur API, contenant le type de méthode de connexion et la valeur

Le connecteur gère la communication avec le service d'authentification et renvoie l'utilisateur correspondant à MyQ

Il existe deux modes de fonctionnement pour l'authentification externe. Elle peut soit constituer le principal moyen d'authentification des utilisateurs, soit être configurée comme authentification de secours en cas d'échec de l'authentification auprès de MyQ. Pour cela, l'option « Utiliser uniquement si l'authentification auprès de la base de données MyQ échoue » peut être sélectionnée.

Demande d'authentification

Méthodes de connexion prises en charge

Ce paramètre définit la méthode de connexion pour laquelle l'authentification externe est utilisée. L'autre méthode de connexion, non sélectionnée, authentifie l'utilisateur par rapport aux identifiants enregistrés dans MyQ.

Badge
Code PIN

MyQ envoie le type de méthode de connexion ainsi que la valeur réelle du code PIN/du badge afin que le connecteur API puisse reconnaître quelle propriété utilisateur doit être utilisée pour trouver l'utilisateur correct.

Par exemple, si un badge est sélectionné et que l'utilisateur s'authentifie sur le terminal intégré avec un badge, MyQ envoie loginType=1&loginValue=1234. Cela peut être interprété comme le numéro du badge 1234.

Si un lecteur de carte émulant des frappes clavier est connecté à l'appareil et qu'un utilisateur passe son badge, MyQ ne peut pas reconnaître si la valeur reçue est un code PIN ou un numéro de badge. MyQ le signale au connecteur API (loginType=7). Le connecteur doit être configuré pour gérer ces requêtes, par exemple en tentant l’authentification à l’aide des deux propriétés utilisateur

Réponse d'authentification

Identifiants d'utilisateur pris en charge

Le connecteur API doit renvoyer une réponse au format JSON contenant l'une de ces valeurs à MyQ afin d'associer l'utilisateur correct et de le connecter au client.

Numéro personnel d'un utilisateur existant dans MyQ
Nom d'utilisateur d'un utilisateur existant dans MyQ

Exemples de réponses :

{"result":0,"personalNumber":"123456"} signifie que l'utilisateur a été identifié avec succès par le service d'authentification et que son numéro personnel est 123456. L'utilisateur ayant ce numéro personnel dans MyQ est authentifié.
{"result":0,"username":"JohnDoe"} signifie que l'utilisateur a été identifié et que son nom d'utilisateur est JohnDoe. L'utilisateur portant ce nom d'utilisateur dans MyQ est authentifié.

États d'erreur

Utilisateur invalide ({"result":1}) -- l'utilisateur a été trouvé, mais son compte n'est pas valide (par exemple, désactivé)
Aucun utilisateur trouvé ({"result":2})-- aucun utilisateur n'est associé aux identifiants

Documentation de l'API

Pour plus de détails sur la mise en œuvre, notamment sur les points de terminaison de l'API et les réponses valides, consultez la documentation de l'API MyQ :

External Authentication API

Cas d'utilisation courants

Le connecteur API externe peut être utilisé de la manière la plus simple pour « traduire » les requêtes. Mais il permet également des workflows d'authentification plus avancés, car le connecteur lui-même peut effectuer un ensemble d'opérations avant de renvoyer l'utilisateur correspondant à MyQ.

Exemple 1 : un service d'authentification non pris en charge par MyQ est requis

Un connecteur qui traduit les appels API entre MyQ et le service d'authentification distant.

Exemple 2 : Workflow d'authentification avancé – identités multiples

L'authentification externe peut être utilisée dans les cas où une opération doit avoir lieu entre MyQ et le serveur d'authentification. Il peut s'agir d'une transformation, d'une reconnaissance avancée des utilisateurs dans des environnements multi-domaines, et plus encore.

Configuration de l'authentification externe

La destination d'authentification externe peut être activée et configurée dans MyQ, sous Paramètres, Authentification utilisateur.

URL : saisissez l'URL où le connecteur API est en cours d'exécution
Nom d'utilisateur : saisissez le nom d'utilisateur requis pour la connexion au serveur externe via l'API
Mot de passe : saisissez le mot de passe requis pour la connexion au serveur externe via l'API
Méthode de connexion : choisissez la méthode de connexion de l'utilisateur - Badge ou Code PIN
Utiliser uniquement si l'authentification auprès de la base de données MyQ échoue : cette option définit si l'authentification externe sera la méthode principale ou secondaire d'authentification
- Si cette option est activée, l'utilisateur est d'abord authentifié auprès du Print Server MyQ, et ce n'est qu'après l'échec de cette authentification que la tentative suivante passe par le service d'authentification à distance
- Si cette option est désactivée, aucune authentification auprès du Print Server MyQ n'est effectuée ; le service d'authentification externe est toujours utilisé