Page History
...
When implementing within the Yellowfin container, the various implementation methods will allow for different functionality to be included. JSPs and Servlets allow for implementing code when the user is directed to a particular URL, whereas Filters filters allow for checking authentication on any URL requested from the Yellowfin system.
Here is an image that describes the a basic process of what a Yellowfin authentication bridge needs to do:
...
- Get details via cookie, file, or network connection.
- Check if the user already exists?
- Creates user with the details provided.
- If required, updates user's details (such as, role, group, etc.)
- Perform a SSO call to log the user in.
Note: If your authentication provider supports SAML, the Yellowfin SAML bridge can be used to SSO users.
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This service connects to Yellowfin and retrieves a logon token for a given user. The user is specified using a user ID (such as an email address or another type of ID depending on the Logon ID method). When this token is passed with the Yellowfin Logon URL, it will disable the login screen for the authenticated users and their session will start immediately.
Request ElementsThe LOGINUSER function will Single Sign On a given user into Yellowfin. The following elements will be passed with this request: Note: The contents of the AdministrationPerson object will be used to define the user being logged in.
These are the parameters that you need to set in the AdministrationPerson object:
The following example shows the parameters that you can pass to this call:
Reponse ElementsThe response returned will contain these parameters:
The service will return the below response:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Redirecting to Yellowfin with the Login TokenUsing the token received from the web service call (the contents of AdministrationResponse.LoginSessionId), you can forward the user to the URL:
This URL will bypass the authentication screen in Yellowfin and take the user directly into Yellowfin.
Using the Token with the JavaScript APIThe SSO token can also be used with embedded JavaScript API widgets. The token is added to the scriptlet URL like this:
Login Session OptionsYou can pass variables/switches that toggle functionality only for the session created via this Single Sign On request. These options can be enabled by passing them via the Parameters attribute in the AdministrationRequest, or by appending them to the redirection URL. Click here to read more about this.
Complete ExampleYou can use the following LOGINUSER example. To try it out, follow these steps:
|
...