--- id: create-connector-rule sidebar_label: Create Connector Rule hide_title: true hide_table_of_contents: true api: {"tags":["Connector Rule Management"],"operationId":"createConnectorRule","description":"Creates a new connector rule.\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"description":"The connector rule to create","content":{"application/json":{"schema":{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule"},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","description":"a map of string to objects"}}}}}},"responses":{"201":{"description":"The created connector rule","content":{"application/json":{"schema":{"description":"ConnectorRuleResponse","allOf":[{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule"},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","description":"a map of string to objects"}}},{"type":"object","required":["id","created"],"properties":{"id":{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"},"created":{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"},"modified":{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"bearerAuth":["idn:connector-rule:write"]}],"method":"post","path":"/connector-rules","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/docs/authentication.html) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/docs/authentication.html#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/docs/authentication.html#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/docs/authentication.html#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/docs/authentication.html#which-oauth-2-0-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/docs/authentication.html#finding-your-tenant-s-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"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":{}},"info":{"contact":{"email":"developers@sailpoint.com","name":"Developer Relations","url":"https://developer.sailpoint.com/discuss"},"description":"These are the public, beta APIs for SailPoint's SaaS services and are subject to change.","title":"SailPoint - Beta SaaS API","version":"3.1.0-beta"},"postman":{"name":"Create Connector Rule","description":{"content":"Creates a new connector rule.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connector-rules"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs/sailpoint-api-beta/sail-point-beta-saa-s-api --- import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem" import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem"; ## Create Connector Rule Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API.
Request Body required
The connector rule to create
    signature object
    The rule's function signature. Describes the rule's input arguments and output (if any)
    input object[]
    output object
    sourceCode object
    SourceCode
The created connector rule
Schema
    signature object
    The rule's function signature. Describes the rule's input arguments and output (if any)
    input object[]
    output object
    sourceCode object
    SourceCode
Client Error - Returned if the request body is invalid.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
Schema
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
Schema
Internal Server Error - Returned if there is an unexpected error.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field