41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# Module `auth`
|
|
|
|
Ce module permet de récupérer des informations concernant l'utilisateur connecté et ses attributs.
|
|
|
|
## Méthodes
|
|
|
|
### `auth.getClaim(ctx: Context, name: string): string`
|
|
|
|
Récupère un attribut associé à l'utilisateur.
|
|
|
|
#### Arguments
|
|
|
|
- `ctx` **Context** Le contexte d'exécution. Voir la documentation du module [`context`](./context.md)
|
|
- `name` **string** Nom de l'attribut à retrouver
|
|
|
|
#### Valeur de retour
|
|
|
|
Valeur de l'attribut associé ou vide si la requête est non authentifiée ou que l'attribut n'a pas été trouvé.
|
|
|
|
#### Usage
|
|
|
|
```js
|
|
function onClientMessage(ctx, message) {
|
|
var subject = auth.getClaim(ctx, auth.CLAIM_SUBJECT);
|
|
console.log("Connected user is", subject);
|
|
}
|
|
```
|
|
|
|
## Propriétés
|
|
|
|
### `auth.CLAIM_SUBJECT`
|
|
|
|
Cette propriété identifie l'utilisateur connecté. Si la valeur retournée par la méthode `getClaim()` est vide, alors l'utilisateur n'est pas connecté.
|
|
|
|
### `auth.CLAIM_ROLE`
|
|
|
|
Cette propriété retourne le rôle de l'utilisateur connecté au sein du "tenant" courant. Si la valeur retournée par la méthode `getClaim()` est vide, alors l'utilisateur n'est pas connecté.
|
|
|
|
### `auth.CLAIM_PREFERRED_USERNAME`
|
|
|
|
Cette propriété retourne le nom "préféré pour l'affichage" de l'utilisateur connecté. Si la valeur retournée par la méthode `getClaim()` est vide, alors l'utilisateur n'est pas connecté ou l'utilisateur n'a pas défini de nom d'utilisateur particulier. |