Adding claims description.

This commit is contained in:
Dessalines 2021-03-19 09:55:27 -04:00
parent b6f2d5df89
commit 5c9bf3ae15

View file

@ -102,7 +102,19 @@ channels:
$ref: "#/components/messages/loginRequest" $ref: "#/components/messages/loginRequest"
subscribe: subscribe:
summary: Login (response) summary: Login (response)
description: Returns an authentication string (`jwt`) for the supplied username or emal description: |-
Returns an authentication string (`jwt`) for the supplied username or email.
The JWT claim is in the following format:
```
Claims {
// local_user_id, standard claim by RFC 7519.
sub: i32,
iss: String,
// Time when this token was issued as UNIX-timestamp in seconds
iat: i64,
}
```
operationId: loginResponseMessage operationId: loginResponseMessage
tags: tags:
- name: User, authentication and admin - name: User, authentication and admin