API Docs for: 0.0.8
Show:

BaseBroker Class

Defined in: client/auth/base/api.js:18
Module: FxaRelierClient

The base class for other brokers. Subclasses must override openFxa. Provides a strategy to authenticate a user.

Constructor

BaseBroker

(
  • clientId
  • [options={}]
)

Defined in client/auth/base/api.js:18

Parameters:

  • clientId String
    • the OAuth client ID for the relier
  • [options={}] Object optional
    • configuration
    • [oauthHost] String optional

      Firefox Accounts OAuth Server host

    • [window] Object optional

      window override, used for unit tests

    • [lightbox] Object optional

      lightbox override, used for unit tests

    • [channel] Object optional

      channel override, used for unit tests

Methods

bestChoice

(
  • config
)

Defined in client/auth/base/api.js:175

Best choice auth strategy, has no action set

Parameters:

  • config Object
    • configuration
    • state String

      CSRF/State token

    • redirectUri String

      URI to redirect to when complete

    • scope String

      OAuth scope

    • [email] String optional

      Email address used to pre-fill into the account form, but the user is free to change it.

forceAuth

(
  • config
)

Defined in client/auth/base/api.js:129

Force a user to sign in as an existing user.

Parameters:

  • config Object
    • configuration
    • state String

      CSRF/State token

    • redirectUri String

      URI to redirect to when complete

    • scope String

      OAuth scope

    • email String

      Email address the user must sign in with. The user is unable to modify the email address and is unable to sign up if the address is not registered.

    • [ui] String optional

      UI to present - lightbox or redirect - defaults to redirect

openFxa

(
  • fxaUrl
  • }
)
protected

Defined in client/auth/base/api.js:96

Open Firefox Accounts to authenticate the user. Must be overridden to provide API specific functionality.

Parameters:

  • fxaUrl String
    • URL to open for authentication
  • } Options=

    options

setContext

(
  • context
)

Defined in client/auth/base/api.js:84

Set the context field to be passed to the content server. If not set, no context will be sent. Should be called by sub-classes if a context is needed.

Parameters:

  • context String

signIn

(
  • config
)

Defined in client/auth/base/api.js:110

Sign in an existing user

Parameters:

  • config Object
    • configuration
    • state String

      CSRF/State token

    • redirectUri String

      URI to redirect to when complete

    • scope String

      OAuth scope

    • [email] String optional

      Email address used to pre-fill into the account form, but the user is free to change it. Set to the string literal blank to ignore any previously signed in email. Default is the last email address used to sign in.

signUp

(
  • config
)

Defined in client/auth/base/api.js:158

Sign up a new user

Parameters:

  • config Object
    • configuration
    • state String

      CSRF/State token

    • redirectUri String

      URI to redirect to when complete

    • scope String

      OAuth scope

    • [email] String optional

      Email address used to pre-fill into the account form, but the user is free to change it.