Skip to content

Commit

Permalink
Merge pull request #127 from aws-samples/development
Browse files Browse the repository at this point in the history
Development to master update readme files for 0.14.4
  • Loading branch information
bobpskier authored Nov 26, 2018
2 parents 4da6bff + 45de064 commit 0dc0bb9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
7 changes: 6 additions & 1 deletion lex-web-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ You can import the library as a module and use it in your code:
lex: {
initialText: 'How can I help you?',
botName: 'helpBot',
botAlias: '$LATEST',
},
ui: {
toolbarTitle: 'Help Bot',
Expand Down Expand Up @@ -208,7 +209,6 @@ Once signed in, three tokens are managed by the lex-web-ui and provided on reque
to Lex. These are the accesstoken, the idtoken, and a refreshtoken. These tokens
are passed as Lex session attributes on each request to Lex.


Configured Fulfillment lambda handlers can utilize these
tokens by accessing them from session attributes. They can be used to
validate access or lookup attributes / assertions from the SSO provider.
Expand All @@ -219,6 +219,11 @@ The session attributes are
* session.idtokenjwt
* session.refreshtokenjwt

The Lex Web UI initially will use the unauth role until a user logs in.
After login processing fully completes, an event fires in the browser indicating tokens
are now available. At that time, the Lex Web UI will switch to using auth based role by
using new temporary credentials.

### Adjusting existing Identity Pools to be used with the lex-web-ui

If you want to manually use your own Cognito Identity Pool,
Expand Down
4 changes: 4 additions & 0 deletions templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ with an existing page, you may want to modify the following parameters:
bot in the Lex
[Getting Started](http://docs.aws.amazon.com/lex/latest/dg/gs-console.html)
documentation.
- `BotAlias`: Lex Bot Alias to use. This parameter defines the alias
to be used by the Lex Web UI. It defaults to a value of '$LATEST'. You can set
this attribute to values which have been defined for the bot and are visible in the
Amazon Lex Console. Typical values might be 'PROD' or 'DEV'.
- `CognitoIdentityPoolId`: Id of an existing Cognito Identity Pool.
This is an optional parameter. If left empty, a Cognito Identity Pool
will be automatically created. The pool ID is used by the web ui to
Expand Down

0 comments on commit 0dc0bb9

Please sign in to comment.