chore: add some docs to NewOpenIDProvider() (#191)
* add some docs to NewOpenIDProvider() * typo
This commit is contained in:
parent
fb0c466839
commit
498b70bae1
1 changed files with 17 additions and 0 deletions
17
pkg/op/op.go
17
pkg/op/op.go
|
@ -117,6 +117,23 @@ type endpoints struct {
|
||||||
JwksURI Endpoint
|
JwksURI Endpoint
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//NewOpenIDProvider creates a provider. The provider provides (with HttpHandler())
|
||||||
|
//a http.Router that handles a suite of endpoints (some paths can be overridden):
|
||||||
|
// /healthz
|
||||||
|
// /ready
|
||||||
|
// /.well-known/openid-configuration
|
||||||
|
// /oauth/token
|
||||||
|
// /oauth/introspect
|
||||||
|
// /callback
|
||||||
|
// /authorize
|
||||||
|
// /userinfo
|
||||||
|
// /revoke
|
||||||
|
// /end_session
|
||||||
|
// /keys
|
||||||
|
//This does not include login. Login is handled with a redirect that includes the
|
||||||
|
//request ID. The redirect for logins is specified per-client by Client.LoginURL().
|
||||||
|
//Successful logins should mark the request as authorized and redirect back to to
|
||||||
|
//op.AuthCallbackURL(provider) which is probably /callback.
|
||||||
func NewOpenIDProvider(ctx context.Context, config *Config, storage Storage, opOpts ...Option) (OpenIDProvider, error) {
|
func NewOpenIDProvider(ctx context.Context, config *Config, storage Storage, opOpts ...Option) (OpenIDProvider, error) {
|
||||||
err := ValidateIssuer(config.Issuer)
|
err := ValidateIssuer(config.Issuer)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue