Class: AuthenticationClient

Authentication Client

The Authentication Client supports three distinct areas of functionality:

1) The client API provides hooks for plugging in a custom sign-on component at the beginning of Finsemble start-up (before application-level components are started). See the Authentication tutorial for an overview of using these hooks.

2) The client API provides hooks for running authentication processes dynamically via "authentication profiles."

3) The client API provides automatic login capabilities for Finsemble components (password auto-fill).

new AuthenticationClient
()
clients/authenticationClient.js, line 31

Methods

beginAuthentication
(params, cb)
clients/authenticationClient.js, line 202

Starts an authentication process. The callback will be triggered when the authentication is totally complete. Use this method if you have a component that needs to complete an authentication process, such as OAuth2.

You must set up an "authentication profile" in your Finsemble config. Reference the name of that profile in params.profile. See the Authentication Tutorial for information on configuration authentication profiles.

Since:
  • TBD
Name Type Description
params object
Name Type Description
profile string

The name of the authentication profile from the authentication config section. See "startup" for instance.

spawnParams object optional

Optionally specify parameters to send to spawn, for when spawning an authentication window.

cb function

Returns an object containing the authentication response, i.e., OAuth credentials, etc

completeOAUTH
(error, params, cb)
clients/authenticationClient.js, line 153

Completes an OAuth2 authentication that was begun with AuthenticationClient#beginAuthentication. This function is called when an OAuth2 response is completed. You should call this function from within the page that you specified in "redirect_uri" in your Authentication Profile config. See the authentication tutorial for more information on configuring OAuth.

Since:
  • TBD
Name Type Description
error string
params object

Optionally pass the OAuth2 query string parameters from your response page. Set to null and the query string will automatically be parsed based on the OAuth2 specification.

cb function

Returns the result (err, data). data will contain the results of the authentication process, such as the access_token and other values provided by your Identify Provider.

getCurrentCredentials
(cb)
clients/authenticationClient.js, line 62

Returns the current global credentials (as published through AuthenticationClient#publishAuthorization) or null if no credentials are set yet.

Since:
  • TBD
Name Type Description
cb function

A function that returns the current credentials. Will return null/undefined if no credentials have yet been established.

publishAuthorization
(user, credentials)
clients/authenticationClient.js, line 48

During Finsemble's start-up process, this function must be invoked before Finsemble will start the application. Once invoked, the authenticated user name and authorization credentials are received by the Authentication Service and published on the "AuthenticationService.authorization" channel. Any component can revieve the credentials by subscribing to that channel or by calling AuthenticationClient#getCurrentCredentials.

Note that all calls to Storage Client are keyed to the authenticated user. See StorageClient#setUser. If authentication is not enabled, then "defaultUser" is used instead.

Name Type Description
user string

the name of the authenticated user

credentials object

the authorization credentials (or token) for the current user, as specified by the application's authentication component.

Example
FSBL.Clients.AuthenticationClient.publishAuthorization(username, credentials);

transmitSignOnToAuthService
(signOnData)
clients/authenticationClient.js, line 74

ALPHA Automatic SignOn Function. Not used by components signing on, but only by "system dialog" component that prompts the user for signon data. This command will send the user-input sign-on data back to the Authentication Service.

Name Type Description
signOnData string