Ueberauth.Auth (Überauth v0.11.0)

View Source

The struct provided to indicate a success of the callback phase.

This struct is constructed by the strategy by using functions defined in the strategy and is provided to the downstream plug in the connections assigns :ueberauth_auth key.

Summary

Types

t()

Holds information obtained in a successful callback phase.

Functions

valid?(auth)

Types

t()

@type t() :: %Ueberauth.Auth{
  credentials: Ueberauth.Auth.Credentials.t(),
  extra: Ueberauth.Auth.Extra.t(),
  info: Ueberauth.Auth.Info.t(),
  provider: String.t() | atom(),
  strategy: module(),
  uid: String.t()
}

Holds information obtained in a successful callback phase.

  • uid - An identifier unique to the given provider, such as a Twitter user ID. Should be stored as a string.
  • provider - The provider name as defined in the configuration.
  • strategy - The strategy module used.
  • info - An info struct about the user. See Ueberauth.Auth.Info.
  • credentials - A struct containing information on the credentials. See Ueberauth.Auth.Credentials.
  • extra - Any additional information that may be available. See Ueberauth.Auth.Extra.

Functions

valid?(auth)