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

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateConnectorRuleV1Request struct via the builder pattern

Name	Type	Description	Notes
connectorrulecreaterequest	Connectorrulecreaterequest	Connector rule to create.

Return type

Connectorruleresponse

HTTP request headers

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

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
)

func main() {
    connectorrulecreaterequest := []byte(``) // Connectorrulecreaterequest | Connector rule to create.

    var connectorrulecreaterequest v1.Connectorrulecreaterequest
    if err := json.Unmarshal(connectorrulecreaterequest, &connectorrulecreaterequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.ConnectorRuleManagementAPI.CreateConnectorRuleV1(context.Background()).Connectorrulecreaterequest(connectorrulecreaterequest).Execute()
	  //resp, r, err := apiClient.ConnectorRuleManagementAPI.CreateConnectorRuleV1(context.Background()).Connectorrulecreaterequest(connectorrulecreaterequest).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.CreateConnectorRuleV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateConnectorRuleV1`: Connectorruleresponse
    fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.CreateConnectorRuleV1`: %v\n", resp)
}

[Back to top]

delete-connector-rule-v1

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

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	ID of the connector rule to delete.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteConnectorRuleV1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
)

func main() {
    id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to delete. # string | ID of the connector rule to delete.

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    r, err := apiClient.ConnectorRuleManagementAPI.DeleteConnectorRuleV1(context.Background(), id).Execute()
	  //r, err := apiClient.ConnectorRuleManagementAPI.DeleteConnectorRuleV1(context.Background(), id).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.DeleteConnectorRuleV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    
}

[Back to top]

get-connector-rule-list-v1

List connector rules List existing connector rules.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetConnectorRuleListV1Request struct via the builder pattern

Name	Type	Description	Notes
limit	int32	Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information.	[default to 50]
offset	int32	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[default to 0]
count	bool	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.	[default to false]

Return type

[]Connectorruleresponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
)

func main() {
    limit := 50 // int32 | 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) (default to 50) # int32 | 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) (default to 50)
    offset := 0 // int32 | 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) (default to 0) # int32 | 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) (default to 0)
    count := true // bool | 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) (default to false) # bool | 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) (default to false)

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.ConnectorRuleManagementAPI.GetConnectorRuleListV1(context.Background()).Execute()
	  //resp, r, err := apiClient.ConnectorRuleManagementAPI.GetConnectorRuleListV1(context.Background()).Limit(limit).Offset(offset).Count(count).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleListV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConnectorRuleListV1`: []Connectorruleresponse
    fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleListV1`: %v\n", resp)
}

[Back to top]

get-connector-rule-v1

Get connector rule Get a connector rule by ID.

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	ID of the connector rule to get.

Other Parameters

Other parameters are passed through a pointer to a apiGetConnectorRuleV1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

Connectorruleresponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
)

func main() {
    id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to get. # string | ID of the connector rule to get.

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.ConnectorRuleManagementAPI.GetConnectorRuleV1(context.Background(), id).Execute()
	  //resp, r, err := apiClient.ConnectorRuleManagementAPI.GetConnectorRuleV1(context.Background(), id).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConnectorRuleV1`: Connectorruleresponse
    fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleV1`: %v\n", resp)
}

[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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	ID of the connector rule to update.

Other Parameters

Other parameters are passed through a pointer to a apiPutConnectorRuleV1Request struct via the builder pattern

Name	Type	Description	Notes

connectorruleupdaterequest | Connectorruleupdaterequest | Connector rule with updated data. |

Return type

Connectorruleresponse

HTTP request headers

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

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
)

func main() {
    id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to update. # string | ID of the connector rule to update.
    connectorruleupdaterequest := []byte(``) // Connectorruleupdaterequest | Connector rule with updated data. (optional)

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.ConnectorRuleManagementAPI.PutConnectorRuleV1(context.Background(), id).Execute()
	  //resp, r, err := apiClient.ConnectorRuleManagementAPI.PutConnectorRuleV1(context.Background(), id).Connectorruleupdaterequest(connectorruleupdaterequest).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.PutConnectorRuleV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PutConnectorRuleV1`: Connectorruleresponse
    fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.PutConnectorRuleV1`: %v\n", resp)
}

[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

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiTestConnectorRuleV1Request struct via the builder pattern

Name	Type	Description	Notes
sourcecode	Sourcecode	Code to validate.

Return type

Connectorrulevalidationresponse

HTTP request headers

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

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/connector_rule_management"
)

func main() {
    sourcecode := []byte(``) // Sourcecode | Code to validate.

    var sourcecode v1.Sourcecode
    if err := json.Unmarshal(sourcecode, &sourcecode); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.ConnectorRuleManagementAPI.TestConnectorRuleV1(context.Background()).Sourcecode(sourcecode).Execute()
	  //resp, r, err := apiClient.ConnectorRuleManagementAPI.TestConnectorRuleV1(context.Background()).Sourcecode(sourcecode).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.TestConnectorRuleV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TestConnectorRuleV1`: Connectorrulevalidationresponse
    fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.TestConnectorRuleV1`: %v\n", resp)
}

[Back to top]

create-connector-rule-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

delete-connector-rule-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

get-connector-rule-list-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

get-connector-rule-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

put-connector-rule-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

test-connector-rule-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

create-connector-rule-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

delete-connector-rule-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

get-connector-rule-list-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

get-connector-rule-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

put-connector-rule-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

test-connector-rule-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example