Behaviour for lifecycle hooks around SCIM operations.

Implement this behaviour to run custom logic before or after SCIM operations. All callbacks are optional. Unimplemented callbacks are no-ops.

Configuration

config :ex_scim, lifecycle_adapter: MyApp.ScimLifecycle

Before hooks

Fire after validation/mapping/metadata, immediately before storage. Can modify domain data or reject the operation by returning {:error, term()}.

After hooks

Fire after the write is committed and mapped to a SCIM response. Observe-only (return :ok).

Before-commit hook

before_commit/4 runs inside the storage transaction, right after the write for create, replace, patch, and delete. It receives the record returned by storage, or the ID for delete. Returning {:error, reason} or raising rolls back the write, skips the after hook, and fires on_error. Use it for work that must be committed with the write. Without ExScim.Storage.Adapter.transaction/1, the write is not rolled back.

Error hook

Fires when an operation fails. Observe-only.

Example

defmodule MyApp.ScimLifecycle do
  use ExScim.Lifecycle.Adapter

  @impl true
  def before_create(:user, data, _caller) do
    if some_business_rule_violated?(data) do
      {:error, {:forbidden, "Business rule violated"}}
    else
      {:ok, data}
    end
  end

  @impl true
  def after_create(:user, scim_response, _caller) do
    MyApp.Notifications.send_welcome(scim_response["id"])
    :ok
  end
end