ConnectorRuleManagementApi

Use this API to implement connector rule management functionality. With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way.

In Identity Security Cloud (ISC), rules serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. Connector-executed rules are rules that are executed in the ISC virtual appliance (VA), usually extensions of the connector itself, the bridge between the data source and ISC.

This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types.

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-connector-rule-v1	POST /connector-rules/v1	Create connector rule
delete-connector-rule-v1	DELETE /connector-rules/v1/{id}	Delete connector rule
get-connector-rule-list-v1	GET /connector-rules/v1	List connector rules
get-connector-rule-v1	GET /connector-rules/v1/{id}	Get connector rule
put-connector-rule-v1	PUT /connector-rules/v1/{id}	Update connector rule
test-connector-rule-v1	POST /connector-rules/v1/validate	Validate connector rule

create-connector-rule-v1

Create connector rule Create a connector rule from the available types.

API Spec

Parameters

Name	Type	Description	Notes
connectorRuleCreateRequest	ConnectorRuleCreateRequest	Connector rule to create.

Return type

ConnectorRuleResponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { ConnectorRuleManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { ConnectorRuleCreateRequest } from 'sailpoint-api-client/dist/connector_rule_management/api';

const configuration = new Configuration();
const apiInstance = new ConnectorRuleManagementApi(configuration);
const connectorRuleCreateRequest: ConnectorRuleCreateRequest = {
  "sourceCode" : {
    "version" : "1.0",
    "script" : "return \"Mr. \" + firstName;"
  },
  "signature" : {
    "output" : {
      "name" : "firstName",
      "description" : "the first name of the identity",
      "type" : "String"
    },
    "input" : [ {
      "name" : "firstName",
      "description" : "the first name of the identity",
      "type" : "String"
    }, {
      "name" : "firstName",
      "description" : "the first name of the identity",
      "type" : "String"
    } ]
  },
  "name" : "WebServiceBeforeOperationRule",
  "description" : "This rule does that",
  "attributes" : { },
  "type" : "BuildMap"
}; // Connector rule to create.
const result = await apiInstance.createConnectorRuleV1({ connectorRuleCreateRequest: connectorRuleCreateRequest });
console.log(result);

[Back to top]

delete-connector-rule-v1

Delete connector rule Delete the connector rule for the given ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the connector rule to delete.	[default to undefined]

Return type

(empty response body)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ConnectorRuleManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ConnectorRuleManagementApi(configuration);
const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // ID of the connector rule to delete.
const result = await apiInstance.deleteConnectorRuleV1({ id: id });
console.log(result);

[Back to top]

get-connector-rule-list-v1

List connector rules List existing connector rules.

API Spec

Parameters

Name	Type	Description	Notes
limit	number	Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information.	[optional] [default to 50]
offset	number	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
count	boolean	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]

Return type

Array<ConnectorRuleResponse>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ConnectorRuleManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ConnectorRuleManagementApi(configuration);
const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const result = await apiInstance.getConnectorRuleListV1({  });
console.log(result);

[Back to top]

get-connector-rule-v1

Get connector rule Get a connector rule by ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the connector rule to get.	[default to undefined]

Return type

ConnectorRuleResponse

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ConnectorRuleManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ConnectorRuleManagementApi(configuration);
const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // ID of the connector rule to get.
const result = await apiInstance.getConnectorRuleV1({ id: id });
console.log(result);

[Back to top]

put-connector-rule-v1

Update connector rule Update an existing connector rule with the one provided in the request body. These fields are immutable: id, name, type

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the connector rule to update.	[default to undefined]
connectorRuleUpdateRequest	ConnectorRuleUpdateRequest	Connector rule with updated data.	[optional]

Return type

ConnectorRuleResponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { ConnectorRuleManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { ConnectorRuleUpdateRequest } from 'sailpoint-api-client/dist/connector_rule_management/api';

const configuration = new Configuration();
const apiInstance = new ConnectorRuleManagementApi(configuration);
const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // ID of the connector rule to update.
const connectorRuleUpdateRequest: ConnectorRuleUpdateRequest = {
  "sourceCode" : {
    "version" : "1.0",
    "script" : "return \"Mr. \" + firstName;"
  },
  "signature" : {
    "output" : {
      "name" : "firstName",
      "description" : "the first name of the identity",
      "type" : "String"
    },
    "input" : [ {
      "name" : "firstName",
      "description" : "the first name of the identity",
      "type" : "String"
    }, {
      "name" : "firstName",
      "description" : "the first name of the identity",
      "type" : "String"
    } ]
  },
  "name" : "WebServiceBeforeOperationRule",
  "description" : "This rule does that",
  "attributes" : { },
  "id" : "8113d48c0b914f17b4c6072d4dcb9dfe",
  "type" : "BuildMap"
}; // Connector rule with updated data. (optional)
const result = await apiInstance.putConnectorRuleV1({ id: id });
console.log(result);

[Back to top]

test-connector-rule-v1

Validate connector rule Detect issues within the connector rule's code to fix and list them.

API Spec

Parameters

Name	Type	Description	Notes
sourceCode	SourceCode	Code to validate.

Return type

ConnectorRuleValidationResponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { ConnectorRuleManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { SourceCode } from 'sailpoint-api-client/dist/connector_rule_management/api';

const configuration = new Configuration();
const apiInstance = new ConnectorRuleManagementApi(configuration);
const sourceCode: SourceCode = {
  "version" : "1.0",
  "script" : "return \"Mr. \" + firstName;"
}; // Code to validate.
const result = await apiInstance.testConnectorRuleV1({ sourceCode: sourceCode });
console.log(result);

[Back to top]