MishkaCmsAuthDiscord (Mishka CMS Auth Discord v0.0.1)

Copy Markdown View Source

A mishka_installer plugin on "auth:providers" (MishkaCmsCore.Accounts.SignInProvider), started by MishkaCmsAuthDiscord.Application: installed, it adds Discord to every site's Security tab → Sign-in methods, where each site switches it on and sets its keys.

Signing in with a Discord account: Assent.Strategy.Discord through the core's one provider strategy, at discord.com (Assent's default is the older discordapp.com), with the identify and email scopes and an application made at discord.com/developers/applications. Its OAuth2 redirect is the site's MishkaCmsCore.Accounts.SignInProvider.callback_url/1. Assent reads Discord's user object as claims — its id the sub, its verified the email_verified — and an account with no email, or one Discord has not verified, does not sign in.

Summary

Types

error_return()
okey_return()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

config()
config(key)
enable()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

on_dependency_error(error)

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

restart()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])
stop()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.

Types

error_return()

@type error_return() ::
  {:error, [%{action: atom(), field: atom(), message: String.t()}]}

okey_return()

@type okey_return() :: {:ok, struct() | map() | module() | [any()]}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

config()

@spec config() :: keyword()

config(key)

@spec config(atom()) :: any()

enable()

@spec enable() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

@spec get() :: keyword()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

@spec health_check() :: :ok | {:degraded, term()} | {:error, term()}

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

on_dependency_error(error)

@spec on_dependency_error(term()) :: term()

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

@spec register() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

restart()

@spec restart() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

@spec start() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])

stop()

@spec stop() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

@spec unregister() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.