User groups and roles can be created and modified with a web service call. The objects returned in the response is dependent on the type of call made in the request.
Note: If the Client Org functionality is switched on in the Configuration page, a Client Org can also be specified where applicable for certain types of calls.
This function returns all the user roles available in Yellowfin. The response contains an array of AdministrationRole objects displaying available roles.
Request ElementsThe following elements will be passed with this request:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete Example Below is a full example of the LISTROLES function. To use it for yourself, carry out the following the steps:
|
This function creates a new role and/or updates a role's functions. The request must contain an AdministrationRole object to specify the role details, and an array of AdministrationFunction for the role. Whether this function is used to update a role, or create a new one, it should be noted that every Yellowfin role requires a mandatory function, Report Access (function code: MIREPORT). MIREPORT access level code must be at least R (read). Each time this function is called, the security functions will be overwritten.
Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationRole object to create a new Yellowfin role:
These are the main parameters that you need to set in the AdministrationFunction object:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete Example Below is a full example of the SAVEROLE function. To use it for yourself, carry out the following the steps:
|
This function deletes a user role, which is specified using the AdministrationRole object, by providing the Role Code.
Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationRole object to create a new Yellowfin role:
These are the main parameters that you need to set in the AdministrationFunction object:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the DELETEROLE function. To use it for yourself, carry out the following the steps:
|
The LISTGROUPS function returns all the groups available in Yellowfin. The response contains an array of AdministrationGroup objects representing available groups. For a list of groups belonging to a specific client, you can pass the Client Org reference ID in the call.
Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationRole object to create a new Yellowfin role:
These are the main parameters that you need to set in the AdministrationFunction object:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the LISTGROUPS function. To use it for yourself, carry out the following the steps:
|
Use this function to retrieve a specified user group with its members. Group name should be provided to the request. Client org reference Id can be passed to manipulate with the client content otherwise default (primary) org will be searched.
Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationRole object to create a new Yellowfin role:
These are the main parameters that you need to set in the AdministrationFunction object:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the GETGROUP function. To use it for yourself, carry out the following the steps:
|
Creates a new user group in the client org provided. If the client reference Id is omitted, the group will be created in default (primary) org. The call requires AdministrationGroup object where you provide new group details. If you supply new group members via AdministrationGroupMember, the members will be added to the created group (this must be existing Yellowfin users). Client org reference Id can be passed to manipulate with the client content otherwise default (primary) org will be used.
Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationRole object to create a new Yellowfin role:
These are the main parameters that you need to set in the AdministrationFunction object:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the CREATEGROUP function. To use it for yourself, carry out the following the steps:
|