mirror of
				https://github.com/Unleash/unleash.git
				synced 2025-10-27 11:02:16 +01:00 
			
		
		
		
	Add example and documentation around triggering login modal #234
This commit is contained in:
		
							parent
							
								
									f08136e508
								
							
						
					
					
						commit
						2bdc05ae15
					
				@ -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 Unlseash",
 | 
			
		||||
    "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)
 | 
			
		||||
 | 
			
		||||
@ -16,7 +16,10 @@ function basicAuthentication(app) {
 | 
			
		||||
            return res
 | 
			
		||||
                .status('401')
 | 
			
		||||
                .set({ 'WWW-Authenticate': 'Basic realm="example"' })
 | 
			
		||||
                .end('access denied');
 | 
			
		||||
                .send({
 | 
			
		||||
                    message: 'You must be authenticated to use Unleash',
 | 
			
		||||
                    path: '/custom/login',
 | 
			
		||||
                });
 | 
			
		||||
        }
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user