View Source Mobilizon.Service.Auth.Applications (Mobilizon v5.0.0-beta.1)

Module to handle applications management

Summary

Types

access_token_details()

Functions

activate_device(user_code, user)

autorize(client_id, redirect_uri, scope, user_id)

autorize_device_application(client_id, user_code)

create(name, redirect_uris, scope, website \\ nil)

generate_access_token(client_id, client_secret, code, redirect_uri, scope)

generate_access_token_for_device_flow(client_id, device_code)

prune_old_application_device_activations()

prune_old_tokens()

refresh_tokens(refresh_token, user_client_id, user_client_secret)

register_device_code(client_id, scope)

revoke_application_token(app_token)

revoke_token(token)

Types

access_token_details()

@type access_token_details() :: %{
  access_token: String.t(),
  expires_in: pos_integer(),
  refresh_token: String.t(),
  refresh_token_expires_in: pos_integer(),
  scope: nil,
  token_type: String.t()
}

Functions

activate_device(user_code, user)

@spec activate_device(String.t(), Mobilizon.Users.User.t()) ::
  {:ok, Mobilizon.Applications.ApplicationDeviceActivation.t()}
  | {:error, Ecto.Changeset.t()}
  | {:error, :not_found}
  | {:error, :expired}

autorize(client_id, redirect_uri, scope, user_id)

@spec autorize(String.t(), String.t(), String.t(), integer()) ::
  {:ok, Mobilizon.Applications.ApplicationToken.t()}
  | {:error, :application_not_found}
  | {:error, :redirect_uri_not_in_allowed}
  | {:error, Ecto.Changeset.t()}

autorize_device_application(client_id, user_code)

@spec autorize_device_application(String.t(), String.t()) ::
  {:ok, Mobilizon.Applications.ApplicationDeviceActivation.t()}
  | {:error, Ecto.Changeset.t()}
  | {:error, :expired}
  | {:error, :access_denied}
  | {:error, :not_found}

create(name, redirect_uris, scope, website \\ nil)

@spec create(String.t(), [String.t()], String.t(), String.t() | nil) ::
  {:ok, Mobilizon.Applications.Application.t()}
  | {:error, Ecto.Changeset.t()}
  | {:error, :invalid_scope}

generate_access_token(client_id, client_secret, code, redirect_uri, scope)

@spec generate_access_token(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t()
) ::
  {:ok, access_token_details()}
  | {:error,
     :application_not_found
     | :redirect_uri_not_in_allowed
     | :provided_code_does_not_match
     | :invalid_client_secret
     | :invalid_or_expired
     | :scope_not_included
     | any()}

generate_access_token_for_device_flow(client_id, device_code)

prune_old_application_device_activations()

prune_old_tokens()

refresh_tokens(refresh_token, user_client_id, user_client_secret)

@spec refresh_tokens(String.t(), String.t(), String.t()) ::
  {:ok, access_token_details()}
  | {:error, :invalid_client_credentials}
  | {:error, :invalid_refresh_token}
  | {:error, any()}

register_device_code(client_id, scope)

@spec register_device_code(String.t(), String.t() | nil) ::
  {:ok, Mobilizon.Applications.ApplicationDeviceActivation.t()}
  | {:error, :application_not_found}
  | {:error, :scope_not_included}
  | {:error, Ecto.Changeset.t()}

revoke_application_token(app_token)

revoke_token(token)

@spec revoke_token(String.t()) ::
  {:ok, map()} | {:error, any(), any(), any()} | {:error, :token_not_found}