diff --git a/docs/securing-unleash.md b/docs/securing-unleash.md index 67a4214313..d7d2b6c735 100644 --- a/docs/securing-unleash.md +++ b/docs/securing-unleash.md @@ -22,6 +22,16 @@ unleash.start({ }); ``` +Additionally, you can trigger the admin interfact to prompt the user to sign in by configuring your middleware to return a `401` status on +protected routes. The response body must contain a `message` and a `path` used to redirect the user to the proper login route. + +```json +{ + "message": "You must be logged in to use Unleash", + "path": "/custom/login" +} +``` + Examples on custom authentication hooks: - [google-auth-hook.js](https://github.com/Unleash/unleash/blob/master/examples/google-auth-hook.js) - [basic-auth-hook.js](https://github.com/Unleash/unleash/blob/master/examples/basic-auth-hook.js)