Boruta.Oauth.AuthorizeApplication behaviour (Boruta core v1.2.0) View Source

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.

Link to this section 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

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 invoking Boruta.Oauth.authorize/3

authorize_success(conn, authorize_response)

Specs

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)

Specs

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)

Specs

preauthorize_success(
  conn :: Plug.Conn.t(),
  authorization :: %Boruta.Oauth.AuthorizationSuccess{
    client: term(),
    code_challenge: term(),
    code_challenge_method: term(),
    redirect_uri: term(),
    scope: term(),
    state: term(),
    sub: term()
  }
) :: any()

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