annon_api v0.16.2 Annon.Plugins.Auth.Strategy behaviour

Behaviour module for Auth strategies.

Link to this section Summary

Types

token_type()

Callbacks

fetch_consumer(token_type, token, settings)

Fetch consumer data

Link to this section Types

Link to this type token_type()

token_type() :: :bearer

Link to this section Callbacks

Link to this callback fetch_consumer(token_type, token, settings)

fetch_consumer(
  token_type :: token_type(),
  token :: String.t(),
  settings :: Map.t()
) :: {:ok, Annon.PublicAPI.Consumer.t()} | {:error, String.t()}

Fetch consumer data.

In case error is returned, it’s message will be sent to API consumer.