Boruta.Oauth.ResourceOwners behaviour (Boruta core v2.3.5)

View Source

Resource owner context

Summary

Callbacks

authorized_scopes(resource_owner)

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, password)

Determines if given password is valid for the given resource owner.

claims(resource_owner, scope)

Returns id_token identity claims for the given resource owner. Those claims will be present in resulting id_token of OpenID Connect flows.

get_by(arg1)

Returns a resource owner by (username) or (id).

Callbacks

authorized_scopes(resource_owner)

@callback 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, password)

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

Determines if given password is valid for the given resource owner.

claims(resource_owner, scope)

(optional) 
@callback claims(resource_owner :: Boruta.Oauth.ResourceOwner.t(), scope :: String.t()) ::
  claims :: Boruta.Oauth.IdToken.claims()

Returns id_token identity claims for the given resource owner. Those claims will be present in resulting id_token of OpenID Connect flows.

get_by(arg1)

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

Returns a resource owner by (username) or (id).