git.iko.soy/typeable/oauth2-proxy
on v5.0.0 help sign in
typeable/oauth2-proxy/docs/5_endpoints.md
18 lines 1.1 kB history raw
1---
2layout: default
3title: Endpoints
4permalink: /endpoints
5nav_order: 5
6---
8## Endpoint Documentation
10OAuth2 Proxy responds directly to the following endpoints. All other endpoints will be proxied upstream when authenticated. The `/oauth2` prefix can be changed with the `--proxy-prefix` config variable.
12- /robots.txt - returns a 200 OK response that disallows all User-agents from all paths; see [robotstxt.org](http://www.robotstxt.org/) for more info
13- /ping - returns a 200 OK response, which is intended for use with health checks
14- /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
15- /oauth2/start - a URL that will redirect to start the OAuth cycle
16- /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.
17- /oauth2/userinfo - the URL is used to return user's email from the session in JSON format.
18- /oauth2/auth - only returns a 202 Accepted response or a 401 Unauthorized response; for use with the [Nginx `auth_request` directive](#nginx-auth-request)