Page History

...

1. Linked with an existing user synchronization process
   In this approach, a user is created at the same time as  a user is created in the external system. This means the user is created before the user attempts to login to Yellowfin for the first time. Updates to the user in the external system would also be propagated to Yellowfin via services immediately.
2. On-Demand (or Lazy) synchronization
   The on-demand  approach will only create a user in Yellowfin as they are about to login for the first time. This can be done in conjunction with an SSO login process. A common pattern is to have the SSO code perform the following process when the user first attempts to log in: -
   

...

1. - Check whether the user attempting to log in to Yellowfin exists

              - If the user does not exist in Yellowfin, create the user

...

When using REST services to create and manage users, a user JSON model needs to be provided. This is the format of the User JSON model:

{

...

“userId": “user1",

...

"emailAddress": "

...

user1@yellowfin.com.au",

...

"roleCode": "Consumer & Collaborator",

...

"password": "secr3t",

...

"firstName": "User",

...

"lastName": "One",

...

"languageCode": "EN",

...

“timeZoneCode": "AUSTRALIA/SYDNEY",

...

 }

When editing or creating users, populate the model with required attributes. Users can be given a First Name, Last Name, Username and Email address, as well as specifying language and timezone settings.

...

The following examples illustrate how to retrieve an existing user (via username) in various programming languages.