plugoid v0.1.0 Plugoid.RedirectURI View Source

Plug to configure the application redirect URI

An OAuth2 / OpenID Connect redirect URI is a vanity, non-dynamic URI. The authorization server redirects to this URI after authentication and authorization success or failure.

Automatic configuration in a router

defmodule Myapp.Router do
  use Plugoid.RedirectURI
end

installs a route to /openid_connect_redirect_uri in a Phoenix router.

Options

:error_view: the error view to be called in case of error. The :"500" template is rendered in case of error (bascially, when the state parameter is missing from the response). If not set, it will be automatically set to MyApp.ErrorView where MyApp is the base module name of the application
:jti_register: a module implementing the JTIRegister behaviour, to check the ID Token against replay attack when a nonce is used (in the implicit and hybrid flows). See also JTIRegister
:path: the path of the redirect URI. Defaults to "openid_connect_redirect_uri"

Options of OIDC.Auth.verify_opts/0 which will be passed to OIDC.Auth.verify_response/3.

Link to this section Summary

Types

opt()

opts()

token_callback()

Link to this section Types

opt()

Specs

opt() ::
  {:error_view, module()}
  | {:jti_register, module()}
  | {:path, String.t()}
  | {:token_callback, token_callback()}

opts()

Specs

opts() :: [opt() | OIDC.Auth.verify_opt()]

token_callback()

Specs

token_callback() ::
  (OIDC.Auth.OPResponseSuccess.t(),
   issuer :: String.t(),
   client_id :: String.t(),
   opts() ->
     any())