Boruta

v0.1.0-rc.1

Boruta v0.1.0-rc.1 Boruta.Oauth.Application behaviour View Source

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.

Link to this section Summary

Callbacks

authorize_error(conn, oauth_error)

This function will be triggered in case of failure triggering Boruta.Oauth.authorize/2

authorize_success(conn, token)

This function will be triggered in case of success triggering Boruta.Oauth.authorize/2

introspect_error(conn, oauth_error)

This function will be triggered in case of failure triggering Boruta.Oauth.introspect/2

introspect_success(conn, token)

This function will be triggered in case of success triggering Boruta.Oauth.introspect/2

token_error(conn, oauth_error)

This function will be triggered in case of failure triggering Boruta.Oauth.token/2

token_success(conn, token)

This function will be triggered in case of success triggering Boruta.Oauth.token/2

Link to this section Callbacks

Link to this callback

authorize_error(conn, oauth_error) View Source 
authorize_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) ::
  Plug.Conn.t()

This function will be triggered in case of failure triggering Boruta.Oauth.authorize/2

Link to this callback

authorize_success(conn, token) View Source 
authorize_success(conn :: Plug.Conn.t(), token :: Boruta.Oauth.Token.t()) ::
  Plug.Conn.t()

This function will be triggered in case of success triggering Boruta.Oauth.authorize/2

Link to this callback

introspect_error(conn, oauth_error) View Source 
introspect_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) ::
  Plug.Conn.t()

This function will be triggered in case of failure triggering Boruta.Oauth.introspect/2

Link to this callback

introspect_success(conn, token) View Source 
introspect_success(conn :: Plug.Conn.t(), token :: Boruta.Oauth.Token.t()) ::
  Plug.Conn.t()

This function will be triggered in case of success triggering Boruta.Oauth.introspect/2

Link to this callback

token_error(conn, oauth_error) View Source 
token_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) ::
  Plug.Conn.t()

This function will be triggered in case of failure triggering Boruta.Oauth.token/2

Link to this callback

token_success(conn, token) View Source 
token_success(conn :: Plug.Conn.t(), token :: Boruta.Oauth.Token.t()) ::
  Plug.Conn.t()

This function will be triggered in case of success triggering Boruta.Oauth.token/2