Guardian v1.1.0 Guardian.Plug.EnsureAuthenticated View Source
This plug ensures that a valid token was provided and has been verified on the request.
If one is not found, the auth_error
will be called with :unauthenticated
This, like all other Guardian plugs, requires a Guardian pipeline to be setup. It requires an implementation module, an error handler and a key.
These can be set either:
- Upstream on the connection with
plug Guardian.Pipeline
- Upstream on the connection with
Guardian.Pipeline.{put_module, put_error_handler, put_key}
- Inline with an option of
:module
,:error_handler
,:key
Options:
claims
- The literal claims to check to ensure that a token is validkey
- The location to find the information in the connection. Defaults to:default
Example
# setup the upstream pipeline
plug Guardian.Plug.EnsureAuthenticated, claims: %{"typ" => "access"}
plug Guardian.Plug.EnsureAuthenticated, key: :secret