Lockspire.Host.BackchannelNotification behaviour (lockspire v1.0.0)

Copy Markdown

Behaviour for triggering out-of-band notifications to users during CIBA flows.

Summary

Types

context()

Callbacks

notify_authentication(ciba_authorization, context)

Invoked after a backchannel authentication request is successfully initiated.

Types

context()

@type context() :: Lockspire.Host.Context.t()

Callbacks

notify_authentication(ciba_authorization, context)

@callback notify_authentication(
  ciba_authorization :: Lockspire.Domain.CibaAuthorization.t(),
  context()
) ::
  :ok | {:error, term()}

Invoked after a backchannel authentication request is successfully initiated.

The host application should use this callback to trigger an out-of-band notification (e.g., push notification, SMS, email) to the user associated with the subject_id in the ciba_authorization.

The binding_message from the authorization should be displayed to the user if provided.