Boruta core v1.0.0-rc.2 Boruta.Oauth.Authorization.ResourceOwner View Source

Resource owner authorization

Link to this section Summary

Functions

Authorize the resource owner corresponding to the given params.

Link to this section Functions

Specs

authorize(
  [email: String.t(), password: String.t()]
  | [{:resource_owner, struct()}]
) ::
  {:error,
   %Boruta.Oauth.Error{
     error: :invalid_resource_owner,
     error_description: String.t(),
     format: nil,
     redirect_uri: nil,
     status: :unauthorized
   }}
  | {:ok, user :: struct()}

Authorize the resource owner corresponding to the given params.

Examples

iex> authorize(id: "id")
{:ok, %User{...}}