Ueberauth Auth0 v0.6.0 Ueberauth.Strategy.Auth0 View Source

Provides an Ueberauth strategy for authenticating with Auth0.

You can edit the behaviour of the Strategy by including some options when you register your provider.

To set the uid_field

config :ueberauth, Ueberauth,
  providers: [
    auth0: { Ueberauth.Strategy.Auth0, [uid_field: :email] }
  ]

Default is :sub

To set the default 'scopes' (permissions):

config :ueberauth, Ueberauth,
  providers: [
    auth0: { Ueberauth.Strategy.Auth0, [default_scope: "openid profile email"] }
  ]

Default is "openid profile email"

To set the audience

config :ueberauth, Ueberauth,
  providers: [
    auth0: { Ueberauth.Strategy.Auth0, [audience: "example-audience"] }
  ]

Not used by default

Link to this section Summary

Functions

Includes the credentials from the Auth0 response.

Populates the extra section of the Ueberauth.Auth struct with auth0's additional information from the /userinfo user profile.

Cleans up the private area of the connection used for passing the raw Auth0 response around during the callback.

Handles the redirect to Auth0.

Fetches the fields to populate the info section of the Ueberauth.Auth struct.

Fetches the uid field from the Auth0 response.

Link to this section Functions

Includes the credentials from the Auth0 response.

Populates the extra section of the Ueberauth.Auth struct with auth0's additional information from the /userinfo user profile.

Cleans up the private area of the connection used for passing the raw Auth0 response around during the callback.

Handles the redirect to Auth0.

Fetches the fields to populate the info section of the Ueberauth.Auth struct.

This field has been changed from 0.5.0 to 0.6.0 to better reflect fields of the OpenID standard claims. Extra fields provided by auth0 are in the Extra struct.

Fetches the uid field from the Auth0 response.