Page History
...
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||
---|---|---|---|---|---|
| |||||
This service connects to Yellowfin and retrieves a login token for a given user which is defined by user ID (such as an email address or any other ID depending on the Login ID method). When this token is passed with the Yellowfin Login URL, it will disable the login screen for the authenticated users and their session will start immediately. For example, if admin@yellowfin.com.au is a web service admin user, the request should be this:
|
...
Where "org1" refers to the client organization reference ID. If this reference ID is not provided, then the user will be redirected to the Client Org Selection page upon logging in.
The LOGINUSER function also allows for different login session parameters to be specified via |
...
the setParameters() method. For example, the code below will log the user, user@yellowfin.com.au, into Yellowfin, but the Yellowfin header will not be displayed, and the user will be taken to the timeline page, once the call is performed.
For more options on similar login session options, click here.
Once the request is configured, perform the call:
Then initialize the Administration web service. Click here to learn how to do this.
The response will contain the following parameters:
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:
Complete ExampleYou can use the following LOGINUSER example. To try it out, follow these steps;
|
...
|
...
|
...
|
...
...
Class | topLink |
---|
...
|
...
title | LOGINUSERNOPASSWORD |
---|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||
---|---|---|---|
|
| ||
|
...
This service is a drop in replacement for LOGINUSER, but the password for the user being logged in is not required. |
...
The user can log in using only their user name. An extra parameter needs to be added to the Configuration table of the Yellowfin database to enable this functionality:
You will receive a web service error 26: UNSECURE_LOGIN_NOT_ENABLED if this configuration option is not added to the Yellowfin database.
|
Styleclass | ||
---|---|---|
| ||
...