`$auth.returnUser`¶

Description¶

Fournit au module d'authentification les infos relatives à l'utilisateur demandé en paramètre.

Cette méthode sert essentiellement à confirmer qu'un utilisateur est autorisé à se connecter sur le serveur d'application. Est sans effet en-dehors de ce contexte d'utilisation.

Syntaxe¶

$auth.returnUser( username , [ password [ , roles [ , otpSecret [ , attributes ] ] ] ] )

Paramètres¶

username string

Nom d'utilisateur que l'on approuve

password string

Mot de passe associé au nom d'utilisateur. La valeur doit être le mot de passe tel qu'il est présent dans l'annuaire ou la base de données dans laquelle le compte utilisateur est trouvé.

Il est conseillé de stocker les mots de passe sous forme de hash, et c'est ce hash qui doit être fourni dans le paramètre password.

Dans le cas d'un client direct, le mot de passe n'est pas requis. Dans ce cas, passer une valeur quelconque ou null au paramètre.

roles array / string

Table de rôles à associer au compte utilisateur

otpSecret string

Clé secrète à utiliser pour l'authentification forte

attributes map

Map d'attributs supplémentaires à rattacher au profil utilisateur

Le map permet par exemple de redéfinir l'attribut preferred_username utilisé dans le cas du client Azure Ad pour véhiculer le nom d'utilisateur. Il est ainsi possible de remplacer l'email utilisé comme login par un nom plus standard.

Retour¶

Retourne toujours null

Exemple¶

Exemple de script très basique chargé de valider l'utilisateur:

@accept(thread = "technical", trigger = "authentication")

if ($string.lowercase($$.username) == "demo" && $$.password == "changeit") {
    $auth.returnUser($$.username,
                     $$.password,
                     [ "foo", "bar" ]);
}

On notera l'utilisation de l'annotation @accept ici pour éviter que le script ne soit utilisable en-dehors du contexte de l'authentification.

$auth.returnUser¶