Skip to main content

Update a Connector Rule

PUT 

https://sailpoint.api.identitynow.com/beta/connector-rules/:id

Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. A token with ORG_ADMIN authority is required to call this API.

Request

Path Parameters

    id stringrequired

    ID of the connector rule to update

    Example: 8c190e6787aa4ed9a90bd9d5344523fb

Body

The connector rule with updated data

    idstringrequired

    the ID of the rule to update

    Example: 8113d48c0b914f17b4c6072d4dcb9dfe
    namestringrequired

    the name of the rule

    Possible values: non-empty and <= 128 characters

    Example: WebServiceBeforeOperationRule
    descriptionstring

    a description of the rule's purpose

    Example: This rule does that
    typestringrequired

    the type of rule

    Possible values: [BuildMap, ConnectorAfterCreate, ConnectorAfterDelete, ConnectorAfterModify, ConnectorBeforeCreate, ConnectorBeforeDelete, ConnectorBeforeModify, JDBCBuildMap, JDBCOperationProvisioning, JDBCProvision, PeopleSoftHRMSBuildMap, PeopleSoftHRMSOperationProvisioning, PeopleSoftHRMSProvision, RACFPermissionCustomization, SAPBuildMap, SapHrManagerRule, SapHrOperationProvisioning, SapHrProvision, SuccessFactorsOperationProvisioning, WebServiceAfterOperationRule, WebServiceBeforeOperationRule, ResourceObjectCustomization]

    Example: BuildMap
    signature object

    The rule's function signature. Describes the rule's input arguments and output (if any)

    input object[]required
  • Array [
  • namestringrequired

    the name of the argument

    Example: firstName
    descriptionstring

    the description of the argument

    Example: the first name of the identity
    typestringnullable

    the programmatic type of the argument

    Example: String
  • ]
  • output objectnullable
    namestringrequired

    the name of the argument

    Example: firstName
    descriptionstring

    the description of the argument

    Example: the first name of the identity
    typestringnullable

    the programmatic type of the argument

    Example: String
    sourceCode objectrequired

    SourceCode

    versionstringrequired

    the version of the code

    Example: 1.0
    scriptstringrequired

    The code

    Example: return "Mr. " + firstName;
    attributesobjectnullable

    a map of string to objects

    Example: {}

Responses

The updated connector rule

Schema
    namestringrequired

    the name of the rule

    Possible values: non-empty and <= 128 characters

    Example: WebServiceBeforeOperationRule
    descriptionstring

    a description of the rule's purpose

    Example: This rule does that
    typestringrequired

    the type of rule

    Possible values: [BuildMap, ConnectorAfterCreate, ConnectorAfterDelete, ConnectorAfterModify, ConnectorBeforeCreate, ConnectorBeforeDelete, ConnectorBeforeModify, JDBCBuildMap, JDBCOperationProvisioning, JDBCProvision, PeopleSoftHRMSBuildMap, PeopleSoftHRMSOperationProvisioning, PeopleSoftHRMSProvision, RACFPermissionCustomization, SAPBuildMap, SapHrManagerRule, SapHrOperationProvisioning, SapHrProvision, SuccessFactorsOperationProvisioning, WebServiceAfterOperationRule, WebServiceBeforeOperationRule, ResourceObjectCustomization]

    Example: BuildMap
    signature object

    The rule's function signature. Describes the rule's input arguments and output (if any)

    input object[]required
  • Array [
  • namestringrequired

    the name of the argument

    Example: firstName
    descriptionstring

    the description of the argument

    Example: the first name of the identity
    typestringnullable

    the programmatic type of the argument

    Example: String
  • ]
  • output objectnullable
    namestringrequired

    the name of the argument

    Example: firstName
    descriptionstring

    the description of the argument

    Example: the first name of the identity
    typestringnullable

    the programmatic type of the argument

    Example: String
    sourceCode objectrequired

    SourceCode

    versionstringrequired

    the version of the code

    Example: 1.0
    scriptstringrequired

    The code

    Example: return "Mr. " + firstName;
    attributesobjectnullable

    a map of string to objects

    Example: {}
    idstringrequired

    the ID of the rule

    Example: 8113d48c0b914f17b4c6072d4dcb9dfe
    createdstringrequired

    an ISO 8601 UTC timestamp when this rule was created

    Example: 021-07-22T15:59:23Z
    modifiedstringnullable

    an ISO 8601 UTC timestamp when this rule was last modified

    Example: 021-07-22T15:59:23Z

Authorization: oauth2

type: Personal Access Token
scopes: idn:rule-management-connector:manage
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sailpoint.api.identitynow.com/beta/connector-rules/:id"
method := "PUT"

payload := strings.NewReader(`{
"id": "8113d48c0b914f17b4c6072d4dcb9dfe",
"name": "WebServiceBeforeOperationRule",
"description": "This rule does that",
"type": "BuildMap",
"signature": {
"input": [
{
"name": "firstName",
"description": "the first name of the identity",
"type": "String"
}
],
"output": {
"name": "firstName",
"description": "the first name of the identity",
"type": "String"
}
},
"sourceCode": {
"version": "1.0",
"script": "return \"Mr. \" + firstName;"
},
"attributes": {}
}`)

client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)

if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer <TOKEN>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/beta
Auth
Parameters
— pathrequired
Body
{
  "id": "8113d48c0b914f17b4c6072d4dcb9dfe",
  "name": "WebServiceBeforeOperationRule",
  "description": "This rule does that",
  "type": "BuildMap",
  "signature": {
    "input": [
      {
        "name": "firstName",
        "description": "the first name of the identity",
        "type": "String"
      }
    ],
    "output": {
      "name": "firstName",
      "description": "the first name of the identity",
      "type": "String"
    }
  },
  "sourceCode": {
    "version": "1.0",
    "script": "return \"Mr. \" + firstName;"
  },
  "attributes": {}
}
ResponseClear

Click the Send API Request button above and see the response here!