View Source Ueberauth.Strategy.Apple (Ueberauth Apple Strategy v0.6.1)

Implementation of an Ueberauth Strategy for "Sign In with Apple".

configuration

Configuration

This provider supports the following configuration:

  • Callback URL: (Required) The URI to which the authorization redirects. It must include a domain name and can’t be an IP address or localhost. Apple will check the provided URL against the domains and redirect URIs configured in your Service ID. Defaults to [...]/auth/:provider/callback according to the configured provider name.

  • Response mode: How response information will be sent back to the server during the callback phase.. Valid values are "query", "fragment", and "form_post". If you requested any scopes, the value must be form_post. Defaults to "query" if no scopes are requested, "form_post" otherwise.

  • Scopes: The amount of user information requested from Apple. Valid values are name and email, with multiple values separated by spaces. You can request one, both, or none. Defaults to no scopes ("").

Link to this section Summary

Functions

Includes the credentials from the Apple response.

Stores the raw information (including the token) obtained from the google callback.

Handles the callback from Apple.

Handles initial request for Apple authentication.

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

Fetches the uid field from the response.

Link to this section Functions

@spec credentials(Plug.Conn.t()) :: Ueberauth.Auth.Credentials.t()

Includes the credentials from the Apple response.

Callback implementation for Ueberauth.Strategy.default_options/0.

@spec extra(Plug.Conn.t()) :: Ueberauth.Auth.Extra.t()

Stores the raw information (including the token) obtained from the google callback.

@spec handle_callback!(Plug.Conn.t()) :: Plug.Conn.t()

Handles the callback from Apple.

@spec handle_request!(Plug.Conn.t()) :: Plug.Conn.t()

Handles initial request for Apple authentication.

@spec info(Plug.Conn.t()) :: Ueberauth.Auth.Info.t()

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

@spec uid(Plug.Conn.t()) :: binary() | nil

Fetches the uid field from the response.