Backplane.Oauth.Authorization protocol (backplane_oauth v1.10.77)

Copy Markdown View Source

OAuth requests authorization

Summary

Types

t()

All the types that implement this protocol.

Functions

preauthorize(request)

Checks if request is valid for token creation for given request, depending of implementation.

token(request)

Creates and returns tokens for given request, depending of implementation.

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

preauthorize(request)

@spec preauthorize(request :: any()) ::
  {:ok, Backplane.Oauth.AuthorizationSuccess.t()}
  | {:error, Backplane.Oauth.Error.t()}

Checks if request is valid for token creation for given request, depending of implementation.

token(request)

@spec token(request :: any()) ::
  {:ok,
   Backplane.Oauth.Token.t()
   | %{
       required(type :: :code | :token | :id_token) =>
         token :: Backplane.Oauth.Token.t() | String.t()
     }}
  | {:error, reason :: term()}
  | {:error, Backplane.Oauth.Error.t()}

Creates and returns tokens for given request, depending of implementation.