View Source DSL: AshAuthentication.UserIdentity

An Ash extension which generates the default user identities resource.

The user identities resource is used to store information returned by remote authentication strategies (such as those provided by OAuth2) and maps them to your user resource(s). This provides the following benefits:

  1. A user can be signed in to multiple authentication strategies at once.
  2. For those provides which support it AshAuthentication can handle automatic refreshing of tokens.


User identities are expected to be relatively long-lived (although they're deleted on log out), so should probably be stored using a permanent data layer sush as ash_postgres.


There is no need to define any attributes, etc. The extension will generate them all for you. As there is no other use-case for this resource it's unlikely that you will need to customise it.

defmodule MyApp.Accounts.UserIdentity do
  use Ash.Resource,
    data_layer: AshPostgres.DataLayer,
    extensions: [AshAuthentication.UserIdentity],
    domain: MyApp.Accounts

  user_identity do
    user_resource MyApp.Accounts.User

  postgres do
    table "user_identities"
    repo MyApp.Repo

If you intend to operate with multiple user resources, you will need to define multiple user identity resources.


Configure identity options for this resource


user_resourcemoduleThe user resource to which these identities belong.
domainmoduleThe Ash domain to use to access this resource.
uid_attribute_nameatom:uidThe name of the uid attribute on this resource.
strategy_attribute_nameatom:strategyThe name of the strategy attribute on this resource.
user_id_attribute_nameatom:user_idThe name of the user_id attribute on this resource.
access_token_attribute_nameatom:access_tokenThe name of the access_token attribute on this resource.
access_token_expires_at_attribute_nameatom:access_token_expires_atThe name of the access_token_expires_at attribute on this resource.
refresh_token_attribute_nameatom:refresh_tokenThe name of the refresh_token attribute on this resource.
upsert_action_nameatom:upsertThe name of the action used to create and update records.
destroy_action_nameatom:destroyThe name of the action used to destroy records.
read_action_nameatom:readThe name of the action used to query identities.
user_relationship_nameatom:userThe name of the belongs-to relationship between identities and users.