# `MishkaCmsAuthSlack`
[🔗](https://github.com/mishka-group/mishka_cms_auth_slack/blob/v0.0.1/lib/mishka_cms_auth_slack.ex#L5)

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

Signing in with a Slack account ("Sign in with Slack", OpenID Connect): `Assent.Strategy.Slack`
through the core's one provider strategy, with an app made at api.slack.com/apps. Under OAuth &
Permissions its redirect URL is the site's
`MishkaCmsCore.Accounts.SignInProvider.callback_url/1`, and the user scopes are `openid`,
`email` and `profile`. Slack says whether the email is verified, and only a verified one signs
in.

# `error_return`

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

# `okey_return`

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

# `child_spec`

Returns a specification to start this module under a supervisor.

See `Supervisor`.

# `config`

```elixir
@spec config() :: keyword()
```

# `config`

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

# `enable`

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

# `get`

```elixir
@spec get() :: keyword()
```

# `health_check`

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

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

# `on_dependency_error`

```elixir
@spec on_dependency_error(term()) :: term()
```

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

# `register`

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

# `restart`

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

# `start`

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

# `start_link`

# `stop`

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

# `unregister`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*