Pristine.OAuth2 (Pristine v0.3.0)

Copy Markdown View Source

Generic OAuth2 control-plane helpers built on Pristine's transport boundary.

Summary

Types

result(value)

Functions

authorization_request(provider, opts \\ [])
authorize_url(provider, opts \\ [])
available?()
client_credentials(provider, opts \\ [])
exchange_code(provider, code, opts \\ [])
introspect_token(provider, token, opts \\ [])
password_token(provider, username, password, opts \\ [])
refresh_token(provider, refresh_token, opts \\ [])
revoke_token(provider, token, opts \\ [])

Types

result(value)

@type result(value) :: {:ok, value} | {:error, Pristine.OAuth2.Error.t()}

Functions

authorization_request(provider, opts \\ [])

@spec authorization_request(Pristine.OAuth2.Provider.t(), keyword()) ::
  result(Pristine.OAuth2.AuthorizationRequest.t())

authorize_url(provider, opts \\ [])

@spec authorize_url(Pristine.OAuth2.Provider.t(), keyword()) :: result(String.t())

available?()

@spec available?() :: boolean()

client_credentials(provider, opts \\ [])

@spec client_credentials(Pristine.OAuth2.Provider.t(), keyword()) ::
  result(Pristine.OAuth2.Token.t())

exchange_code(provider, code, opts \\ [])

@spec exchange_code(Pristine.OAuth2.Provider.t(), String.t(), keyword()) ::
  result(Pristine.OAuth2.Token.t())

introspect_token(provider, token, opts \\ [])

@spec introspect_token(Pristine.OAuth2.Provider.t(), String.t(), keyword()) ::
  result(map())

password_token(provider, username, password, opts \\ [])

@spec password_token(Pristine.OAuth2.Provider.t(), String.t(), String.t(), keyword()) ::
  result(Pristine.OAuth2.Token.t())

refresh_token(provider, refresh_token, opts \\ [])

@spec refresh_token(Pristine.OAuth2.Provider.t(), String.t(), keyword()) ::
  result(Pristine.OAuth2.Token.t())

revoke_token(provider, token, opts \\ [])

@spec revoke_token(Pristine.OAuth2.Provider.t(), String.t(), keyword()) ::
  result(map())