Boruta.Oauth.AuthorizeApplication behaviour (Boruta core v2.3.5)

OAuth application behaviour - authorize endpoint

Implement this behaviour in the application layer of your OAuth provider. The callbacks are triggered while calling functions from Boruta.Oauth module.

Summary

Callbacks

authorize_error(conn, oauth_error)

This function will be triggered in case of failure invoking Boruta.Oauth.authorize/3

authorize_success(conn, authorize_response)

This function will be triggered in case of success invoking Boruta.Oauth.authorize/3

preauthorize_error(conn, oauth_error)

This function will be triggered in case of failure invoking Boruta.Oauth.preauthorize/3

preauthorize_success(conn, authorization)

This function will be triggered in case of success invoking Boruta.Oauth.preauthorize/3

Callbacks

authorize_error(conn, oauth_error)

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

This function will be triggered in case of failure invoking Boruta.Oauth.authorize/3

authorize_success(conn, authorize_response)

@callback authorize_success(
  conn :: Plug.Conn.t(),
  authorize_response :: Boruta.Oauth.AuthorizeResponse.t()
) :: any()

This function will be triggered in case of success invoking Boruta.Oauth.authorize/3

preauthorize_error(conn, oauth_error)

(optional)

@callback preauthorize_error(
  conn :: Plug.Conn.t(),
  oauth_error :: Boruta.Oauth.Error.t()
) :: any()

This function will be triggered in case of failure invoking Boruta.Oauth.preauthorize/3

preauthorize_success(conn, authorization)

(optional)

@callback preauthorize_success(
  conn :: Plug.Conn.t(),
  authorization :: Boruta.Oauth.AuthorizationSuccess.t()
) :: any()

This function will be triggered in case of success invoking Boruta.Oauth.preauthorize/3