Page History
...
This section will outline how to create, manipulate, and delete users via web services. It is assumed that the web service is called to mirror user changes immediately after a user modification is made in the OEM application.
Main Functions
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Creates a new user account in Yellowfin.
Here's a basic request to create a new Yellowfin user:
Complete Example of ADDUSERFollowing is a full example of this function, that you can use in your code. Follow these steps first:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||
---|---|---|---|---|---|
| |||||
This function creates users in bulk. It works similar to the ADDUSER function, however this requires that you pass an array of AdministrationPerson objects. Note: Ensure that you mention the proper nameof name of this function, which is ADDUSERS.
Complete Example of the ADDUSERSThis example code adds two new Yellowfin users, user1@yellowfin.com.au and user2@yellowfin.com.au, in the default organization. To try it out, follow these steps first:
|
Expand | ||
---|---|---|
| ||
This function allows bulk user creation similar to ADDUSERS, however, this time if a user-to-add login Id in use or email is in use or password is not supplied, there will be no exceptions generated and the user will not be created. The response will contain an array of AdministrationPerson object containing failed users that was not added. The code will be exactly like ADDUSERS sample with only difference
|
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to delete a user:
This code will return This function will delete a user from Yellowfin. The details in the AdministrationPerson object will be used in the user deletion process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
...