Ueberauth.Auth.Credentials (Überauth v0.11.0)

View Source

Provides information about the credentials of a request.

Summary

Types

t()

Information about the credentials of a request.

Types

t()

@type t() :: %Ueberauth.Auth.Credentials{
  expires: boolean() | nil,
  expires_at: number() | nil,
  other: map(),
  refresh_token: binary() | nil,
  scopes: [String.t()],
  secret: binary() | nil,
  token: binary() | nil,
  token_type: String.t() | nil
}

Information about the credentials of a request.

  • token - The access token supplied by OAuth and OAuth 2.0 providers.
  • refresh_token - The refresh token supplied by OAuth 2.0 providers.
  • token_type - The type of token provided.
  • secret - The access token secret supplied by OAuth providers.
  • expires - Boolean indicating whether the access token has an expiry date.
  • expires_at - Timestamp of the expiry time. Facebook and Google return this. Twitter, LinkedIn don't.
  • scopes - A list of scopes/permissions that were granted.
  • other - Other credentials that may not fit in the other fields.