Boruta.Oauth.Application behaviour (Boruta core v0.2.1) 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

revoke_error(conn, oauth_error)

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

revoke_success(conn)

This function will be triggered in case of success triggering Boruta.Oauth.revoke/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

authorize_error(conn, oauth_error)

Specs

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

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

authorize_success(conn, token)

Specs

authorize_success(
  conn :: Plug.Conn.t(),
  token :: Boruta.Oauth.AuthorizeResponse.t()
) :: any()

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

introspect_error(conn, oauth_error)

Specs

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

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

introspect_success(conn, token)

Specs

introspect_success(
  conn :: Plug.Conn.t(),
  token :: Boruta.Oauth.IntrospectResponse.t()
) :: any()

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

revoke_error(conn, oauth_error)

Specs

revoke_error(conn :: Plug.Conn.t(), oauth_error :: Boruta.Oauth.Error.t()) ::
  any()

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

revoke_success(conn)

Specs

revoke_success(conn :: Plug.Conn.t()) :: any()

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

token_error(conn, oauth_error)

Specs

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

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

token_success(conn, token)

Specs

token_success(conn :: Plug.Conn.t(), token :: Boruta.Oauth.TokenResponse.t()) ::
  any()

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