Skip to main content

Web Services Before Operation Rule


This rule calculates attributes before a web-service operation call.


  • Connector Execution - This rule executes within the virtual appliance. It may offer special abilities to perform connector-related functions, and it may offer managed connections to sources.
  • Logging - Logging statements are viewable within the ccg.log on the virtual appliance, and they are viewable by SailPoint personnel.

Rule Execution


applicationsailpoint.object.ApplicationApplication whose data file is being processed.
provisioningPlansailpoint.object.ProvisioningPlanProvisioning plan used to update the payload of the http request. The provisioning plan has an account request that defines the operation to be performed on the account. An account request can contain multiple attributes requests. Each attribute request represents an operation on a single account attribute. This argument enables the user to update the body/payload or URL attributes of an endpoint object using the provisioningPlan information.
requestEndPointsailpoint.connector.webservices.EndPointCurrent request information. It contains the header, body, context url, method type, response attribute map, and successful response code.
restClientsailpoint.connector.webservices.WebServicesClientWebServicesClient (HttpClient) object that enables the user to call the Web Services API target system.
oldResponseMapjava.util.MapResponse object returned from earlier endpoint configuration of the same operation type, like Account Aggregation, Get Object, etc.


EndPoint / Mapsailpoint.connector.webservices.EndPoint / sailpoint.connector.webservices.MapThe rule allows the user to return the endpoint object (requestEndPoint) or a map. The map can hold updatedEndPoint and connectorStateMap keys where the value expected are Endpoint (requestEndPoint) and connectorStateMap object respectively. The connectorStateMap object is a map that contains a key and a value for the attribute that must be updated in the application by the rule.
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE Rule PUBLIC "sailpoint.dtd" "sailpoint.dtd">
<Rule name="Example Rule" type="WebServiceBeforeOperationRule">
<Description>Describe your rule here.</Description>

// Add your logic here.

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE Rule PUBLIC "sailpoint.dtd" "sailpoint.dtd">
<Rule name="Example Rule" type="WebServiceBeforeOperationRule">
<Description>This rule is used by the Web Services connector before performing any operation like testconnection, aggregation etc.</Description>
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import connector.common.JsonUtil;
import connector.common.Util;
import sailpoint.connector.webservices.EndPoint;
import sailpoint.connector.webservices.WebServicesClient;
import sailpoint.object.Application;
import sailpoint.object.ProvisioningPlan;
import sailpoint.object.ProvisioningPlan.AccountRequest;

Map body = requestEndPoint.getBody();
String jsonBody = (String) body.get("jsonBody");"Rule - Modify Body: running");

try {

Map jsonMap = JsonUtil.toMap(jsonBody);
if (jsonMap != null) {
Object roleEntry = jsonMap.get("webSiteAndRole");
String role = "";
if (roleEntry != null && roleEntry instanceof ArrayList) {
ArrayList rolesArray = (ArrayList) roleEntry;
if (rolesArray.size() > 0) {
role = (String) rolesArray.get(0);
} else if (roleEntry != null) {
role = (String) roleEntry;

jsonMap.put("webSiteAndRole", role);"Rule - Modify Body: setting webSiteAndRole = " + role);
String webID = "";
if (provisioningPlan != null) {"Rule - Modify Body: plan is not null");
for (AccountRequest accReq : Util.iterate(provisioningPlan.getAccountRequests())) {"Rule - Modify Body: iterating over account requests");
for (ProvisioningPlan.AttributeRequest attReq : Util.iterate(accReq.getAttributeRequests())) {"Rule - Modify Body: iterating over attribute requests");
String attrName = attReq.getName();
String value = null;
if (attrName != null && "webId".equalsIgnoreCase(attrName)) {
webID = (String) attReq.getValue();"Rule - Modify Body: setting webID = " + webID);
} else {"Rule - Modify Body: plan is null");

if (!"".equals(webID)) {
jsonMap.put("webID", webID);

// Add in any other missing fields that are required
if (!jsonMap.containsKey("webLogonEmail")) {
jsonMap.put("webLogonEmail", "");
if (!jsonMap.containsKey("taxID")) {
jsonMap.put("taxID", "");
if (!jsonMap.containsKey("taxIdType")) {
jsonMap.put("taxIdType", "");
if (!jsonMap.containsKey("actorLogonId")) {
jsonMap.put("actorLogonId", "");

String finalBody = JsonUtil.render(jsonMap);
body.put("jsonBody", finalBody);
} catch (Exception ex) {
log.error("Rule - Modify Body: " + ex);

return requestEndPoint;

Attach to Source

Refer to Attaching Connector-Related Rules to Sources for details on how to attach your rule to your source.