# AshAuthentication

<img src="" alt="Ash Authentication Logo" width="250"/>

![Elixir CI](
[![License: MIT](](
[![Hex version badge](](

AshAuthentication provides drop-in support for user authentication for users of
the [Ash framework](  It is designed to be highly
configurable, with sensible defaults covering the most common use-cases.

## Warning

This is not beta software, but it is still relatively young, and authentication is a very critical flow in any application, that touches on many aspects of security. We highly encourage considering how you configure this package very carefully, and testing its behavior in your own application. Those tests will also help ensure that any custom behavior you implement by modifying your resources does not break your authentication flows. Even though we do our best to prevent that situation with compile time validations, its not always possible.

## Installation

The package can be installed by adding `ash_authentication` to your list of
dependencies in `mix.exs`:

def deps do
    {:ash_authentication, "~> 3.11.10"}

## Documentation

See the [official documentation]( for more.

Additionally, documentation for the latest release will be [available on
hexdocs]( and for the [`main`

## Contributing

  * To contribute updates, fixes or new features please fork and open a
    pull-request against `main`.
  * Please use [conventional
    commits]( - this allows us to
    dynamically generate the changelog.
  * Feel free to ask any questions on out [GitHub discussions

## Licence

`AshAuthentication` is licensed under the terms of the [MIT
license](  See the [`LICENSE` file in this
for details.