View Source Boruta.Oauth.ResourceOwners behaviour (Boruta core v2.1.0)

Resource owner context

Link to this section Summary

claims()

Returns a list of authorized scopes for a given resource owner. These scopes will be granted is requested for the user.

Determines if given password is correct.

Returns id_token identity claims for the given resource owner

get_by(arg1)

Returns a resource owner by (username, password) or (id). Returns nil for non matching results.

claims() :: %{required(String.t()) => String.t() | claims()}

authorized_scopes(resource_owner :: Boruta.Oauth.ResourceOwner.t()) :: [
  Boruta.Oauth.Scope.t()
]

Returns a list of authorized scopes for a given resource owner. These scopes will be granted is requested for the user.

check_password(
  resource_owner :: Boruta.Oauth.ResourceOwner.t(),
  password :: String.t()
) :: :ok | {:error, String.t()}

Determines if given password is correct.

(optional)

claims(resource_owner :: Boruta.Oauth.ResourceOwner.t(), scope :: String.t()) ::
  claims :: claims()

Returns id_token identity claims for the given resource owner

get_by([{:username, String.t()}] | [{:sub, String.t()}]) ::
  {:ok, resource_owner :: Boruta.Oauth.ResourceOwner.t()} | {:error, String.t()}

Returns a resource owner by (username, password) or (id). Returns nil for non matching results.