wassname/talk
1
0
Fork 0
mirror of https://github.com/wassname/talk.git synced 2026-08-07 11:29:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

updates to docs

Browse Source
This commit is contained in:
Wyatt Johnson
2017-08-04 16:10:08 +10:00
parent 190e93c8d7
commit a39b7237e6
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_docs/02-01-configuration.md
+15
View File
@@ -100,6 +100,21 @@ is not needed in most situations.
user id should be stored/read to/from. Example `user.id` would store it like: `{user: {id}}`
on the claims object. (Default `sub`)
When integrating with an external authentication system, the following JWT claims
will be used:
```js
{
"jti": "<the unique token identifier>", // *required* unique id used for blacklisting
"aud": TALK_JWT_AUDIENCE, // *optional* if TALK_JWT_DISABLE_AUDIENCE === 'TRUE', *required* otherwise
"iss": TALK_JWT_ISSUER, // *optional* if TALK_JWT_DISABLE_ISSUER === 'TRUE', *required* otherwise
[TALK_JWT_USER_ID_CLAIM]: "<the user id>", // *required* the id of the user
// Note, if TALK_JWT_USER_ID_CLAIM contains '.', it will be used to deliniate an object, for example
// `user.id` would store it like: `{user: {id}}`
}
```
### Email
- `TALK_SMTP_EMAIL` (*required for email*) - the address to send emails from