Skip to content

Commit

Permalink
docs: add docs on missing redirect.callback option (#128)
Browse files Browse the repository at this point in the history
  • Loading branch information
benmccallum authored and pi0 committed Apr 10, 2018
1 parent ae3d549 commit ad22695
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,16 @@ Default:
```js
redirect: {
login: '/login',
logout: '/'
logout: '/',
callback: '/login',
home: '/'
}
```

* `login`: User will be redirected to this path if *login is required*.
* `logout`: User will be redirected to this path if *after logout current route is protected*.
* `user`: User will be redirect to this path *after login*. (`rewriteRedirects` will rewrite this path)
* `logout`: User will be redirected to this path if *after logout, current route is protected*.
* `callback`: User will be redirect to this path by the identity provider *after login*. (Should match configured `Allowed Callback URLs` (or similar setting) in your app/client with the identity provider)
* `user`: User will be redirected to this path *after login and callback is processed*. (`rewriteRedirects` will rewrite this path)

Each redirect path can be disabled by setting to `false`.
Also you can disable all redirects by setting `redirect` to `false`
Expand Down

0 comments on commit ad22695

Please sign in to comment.