Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthenticatorCallback

Single-use callback provided to the authenticate call.

Hierarchy

  • AuthenticatorCallback

Index

Methods

Methods

abstain

  • abstain(): void
  • The authentication has neither passed nor failed.

    throws

    an error if another method has already been invoked on this callback

    Returns void

allow

  • Authentication passed - allow the authentication request with modifications to the session properties.

    throws

    an error if another method has already been invoked on this callback

    Parameters

    • properties: SessionProperties

      this can include all allowed user-defined session properties, as well as a subset of fixed session properties see authenticate.

    Returns void

  • Authentication passed - allow the authentication request with fixed properties as supplied but no user-defined properties.

    throws

    an error if another method has already been invoked on this callback

    Returns void

deny

  • deny(): void
  • Authentication failed - deny the authentication request.

    throws

    an error if another method has already been invoked on this callback

    Returns void