Packages
boruta
0.2.1
3.0.0-beta.4
3.0.0-beta.3
3.0.0-beta.2
3.0.0-beta.1
2.3.6
2.3.5
2.3.4
2.3.3
2.3.2
2.3.1
2.3.0
2.2.2
2.2.1
2.2.0
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.1
2.0.0
2.0.0-rc.1
2.0.0-rc.0
1.2.1
1.2.0
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.2.1
0.2.0
0.1.1
0.1.0
0.1.0-rc.5
0.1.0-rc.4
0.1.0-rc.3
0.1.0-rc.2
0.1.0-rc.1
Core of an OAuth/OpenID Connect provider enabling authorization in your applications.
Current section
Files
Jump to
Current section
Files
lib/boruta/oauth/application.ex
defmodule Boruta.Oauth.Application do
@moduledoc """
OAuth application behaviour
Implement this behaviour in the application layer of your OAuth provider. The callbacks are triggered while calling functions from `Boruta.Oauth` module.
"""
@doc """
This function will be triggered in case of success triggering `Boruta.Oauth.token/2`
"""
@callback token_success(conn :: Plug.Conn.t(), token :: Boruta.Oauth.TokenResponse.t()) :: any()
@doc """
This function will be triggered in case of failure triggering `Boruta.Oauth.token/2`
"""
@callback token_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) :: any()
@doc """
This function will be triggered in case of success triggering `Boruta.Oauth.authorize/2`
"""
@callback authorize_success(conn :: Plug.Conn.t(), token :: Boruta.Oauth.AuthorizeResponse.t()) :: any()
@doc """
This function will be triggered in case of failure triggering `Boruta.Oauth.authorize/2`
"""
@callback authorize_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) :: any()
@doc """
This function will be triggered in case of success triggering `Boruta.Oauth.introspect/2`
"""
@callback introspect_success(conn :: Plug.Conn.t(), token :: Boruta.Oauth.IntrospectResponse.t()) :: any()
@doc """
This function will be triggered in case of failure triggering `Boruta.Oauth.introspect/2`
"""
@callback introspect_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) :: any()
@doc """
This function will be triggered in case of success triggering `Boruta.Oauth.revoke/2`
"""
@callback revoke_success(conn :: Plug.Conn.t()) :: any()
@doc """
This function will be triggered in case of failure triggering `Boruta.Oauth.revoke/2`
"""
@callback revoke_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) :: any()
end