From a39b7237e692ea3bc0a17860b16c17e03ba9c53f Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Fri, 4 Aug 2017 16:10:08 +1000 Subject: [PATCH] updates to docs --- docs/_docs/02-01-configuration.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/_docs/02-01-configuration.md b/docs/_docs/02-01-configuration.md index 475823b4c..74bd8972e 100644 --- a/docs/_docs/02-01-configuration.md +++ b/docs/_docs/02-01-configuration.md @@ -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": "", // *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]: "", // *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