Endpoints
STOPnik provides the following endpoints.
When server.basePath is configured, all endpoints are prefixed with it, e.g. /auth/account.
STOPnik
Account
This endpoint will provide a login or logout form.
/account
Logout
This endpoint will logout the current user and redirect when a redirect is configured.
A redirect provided by the logout form is only used, when it is a path on STOPnik itself,
otherwise the configured server.logoutRedirect is used.
/logout
Health
This endpoint will return a JSON which either contains only a ping - pong or additional user details.
User details are only provided when the health endpoint is called with a valid access token.
/health
ForwardAuth
STOPnik supports Traefik ForwardAuth out of the box.
This endpoint depends on the provided configuration and is only available when server.forwardAuth.externalUrl is set.
The endpoint must only be reachable through Traefik, as it trusts the X-Forwarded-* headers.
/forward
OAuth 2.0
The OAuth 2.0 Authorization Framework
/authorize/token
Following the OAuth 2.0 Security Best Current Practice
- an authorization code can only be redeemed once, by the client it was issued to and with the same
redirect_uriused for the authorization request - when a
code_challengewas provided, thecode_verifieris required, public clients must use PKCE - refresh tokens are rotated, each refresh token can only be used once and a new refresh token is returned
- tokens of the implicit grant are returned in the fragment of the redirect URI, not in the query
- request objects (
requestparameter) are not supported and rejected withrequest_not_supported
OAuth 2.0 Token Introspection
/introspect
OAuth 2.0 Token Revocation
/revoke
OAuth 2.0 Authorization Server Metadata
/.well-known/oauth-authorization-server/keys
OpenId Connect
OpenId Connect endpoint are only available, when one of the clients has the oidc flag set.
OpenID Connect Discovery 1.0
/.well-known/openid-configuration/keys
OpenID Connect Core 1.0
/userinfo