Knowledge Article

Best Practices for Rule Deployments

Author

  • Ishim_Manon

    SailPoint

Introduction

SailPoint Identity Security Cloud deployments often require rules to be deployed to the client’s IdentityNow tenants. Because IdentityNow is a multi-tenant solution, poorly written rules can have negative performance implications on other tenants in the same cloud. As such, SailPoint requires all rules to be reviewed prior to deployment. Completing these reviews requires an expert services contract to leverage billable hours.

This article covers common topics around this process, including best practices, rule review expectations, and more.

SLAs for Rule Review

SailPoint has a 24 hour SLA on rule deployments for rules submitted over weekdays and next business day for rules submitted over the weekend. SailPoint rule review team members work from 9am-5pm Monday-Friday in their local time zones, excluding holidays.

However, around 65% of rule reviews are completed in less 4 business hours, with the average turnaround time of 3-6 hours after ticket has been assigned. If a specific deployment window is required, SailPoint must be alerted at least 48 hours in advance so that the time for the reviewer and deployment expert may be reserved.

Go Live expectations

SailPoint rule review team members work from 9am-5pm Monday-Friday in their local time zones, excluding holidays. For clients planning to go live on a weekend, we recommend having rules deployed in the sandbox environment prior to go live so that they can be promoted to production without SailPoint involvement. See the section below entitled “Promoting Rules from Sandbox to Production”.

Note that even for clients who purchase Weekend Go-Live Support, rule deploys are not covered in the Weekend Go Live service as there are multiple teams involved in the rule deploy process.

Rule Validator

Because all rules require SailPoint approval before being deployed in a client environment, we want to make the process as quick and seamless as possible. We created the Rule Validator tool to allow clients to get as far as possible in validating that their rules are ready to go before engaging SailPoint. Running the rule validator before submitting reduces the likelihood that a rule will be rejected and helps to minimize the amount of time that is billed for a given rule review.

Customers must submit any rule change/create request with validator outputs.

SailPoint SaaS Rule Validator can be found here: https://community.sailpoint.com/t5/Professional-Services/IdentityNow-Rule-Validator/ta-p/166116

Rule Deployments

SailPoint recommends only submitting one rule at a time or only rules that should be deployed together. Each open ticket can only be used to make one deployment. Subsequent deployments will require additional tickets to be open.

Typical rule reviews are billed 15-30 minutes per rule. However, this can vary based on the complexity of the rule or if the rule is rejected and must be resubmitted for review.

In the case of rejection, we recommend submitting a new ticket to avoid a scenario where a case owner is out of the office.

Exceptions during Runtime

SailPoint Rule Reviewers don’t necessarily have business knowledge, so they will focus the review on correct syntax, but they won’t be able to guarantee that the rule will do what it’s expected to and the rule may throw a runtime exception. To mitigate this, SailPoint recommends the following:

  1. Customer should validate referenced object names in rules.
    1. Make sure of using Name instead of displayName.
    2. Make sure of using “Active Directory [source]” instead of “Active Directory [source-248764]”. Don’t include numeric ID of sources.
    3. Make sure of not migrating rules with same name as Sandbox to Production which have the same Sandbox source names.
  2. Customer should use correct IdentityAttribute / LifeCycle State Names [ ex : firstName instead of firstname]
  3. Customer should create a backend searchable AccountAttribute while using IDNRuleUtil methods.

Naming conventions

Please refer to the corresponding section of our Rule guide: https://community.sailpoint.com/t5/IdentityNow-Articles/IdentityNow-Rule-Guide/ta-p/76665#:~:text=should%20be%C2%A0%3E-,Rule%20File%20Naming,-The%20file%20naming

Version Control

Customer must maintain a rule repository on their end with version control tools like GitHub.

Connector Rule deployments

Connector Rules do not need Expert Services intervention to be deployed in a customer tenant. Customers are able to deploy connector rules on their end using API call.

API Call:
POST https://{Tenant}.identitynow.com/beta/connector-rules

BODY: Content - Type: JSON

{
"name": "Name Of the Rule",
"description": "Description for the Rule",
"type": "Rule Type - Please see the list of types in the URL Below",
"sourceCode": {
"version":"1.0",
"script" : "SOURCE CODE in Escaped format. I have attached a link to a reliable Formatter in the Link Below"
},
"attributes": {}
}

You can find more information about the API call on this URL: https://developer.sailpoint.com/idn/api/beta/connector-rule-management

You can use these API calls to validate the connector Rules: https://developer.sailpoint.com/idn/api/beta/connector-rule-management

Promoting rules from sandbox to production

Steps for exporting and importing a config object from sandbox to production environment without ANY change.

  1. Initiate the Export

API: Download Result of Export Job
Choose the object you are looking to migrate. Using the includeTypes and includedNamesis the best way to ensure you’re including migrated objects. For storing objects for backup, excludeTypes and excludeNames can be used.

Example Request:
POST https://{tenant}.api.identitynow.com/beta/sp-config/export

{
"description": "Export Rule",
"includeTypes":["RULE"],
"objectOptions":{"RULE":
{"includedNames": ["<Name of the rule>"]
}
}
}

If successful, you’ll get a 202 “Accepted” request with the ID of the export job, similar to the following:

{
"jobId": "12ab34c5-abcd-123a-a1b2-ab12c3de456e",
"status": "NOT_STARTED",
"type": "EXPORT",
"message": null,
"description": "Export Rule",
"expiration": "2022-09-27T01:58:22.605Z",
"created": "2022-09-20T01:58:22.605Z",
"modified": "2022-09-20T01:58:22.605Z",
"completed": null
}

  1. Check the Export Job Status

API: Get Status of Export Job
Using the same “jobId” returned in the result of the Initiated export, get the status to see if it has completed, is still pending, or has failed.

URL

GET https://{tenant}.api.identitynow.com/beta/sp-config/export/{id}

Example Request:

GET /beta/sp-config/export/54fe22e5-deef-428e-a8d8-cb05f4da242e

Successful Output:

{
"jobId": "12ab34c5-abcd-123a-a1b2-ab12c3de456e",
"status": "COMPLETE",
"type": "EXPORT",
"message": null,
"description": "Export Rule",
"expiration": "2022-09-27T01:58:22Z",
"created": "2022-09-20T01:58:22.605Z",
"modified": "2022-09-20T01:58:23.705Z",
"completed": "2022-09-20T01:58:23.701Z"
}

  1. Download the JSON Export

API: Download Result of Export Job

Using the same “jobId” returned in the result of the Initiated export, get the status to see if it has completed, is still pending, or has failed

URL

GET https://{tenant}.api.identitynow.com/beta/sp-config/export/{id}/download

Example Request:

GET /beta/sp-config/export/54fe22e5-deef-428e-a8d8-cb05f4da242e/download

Successful Output:

{
"version": 1,
"timestamp": "2022-09-20T01:58:23.599136Z",
"tenant": "companytenandname",
"description": "Export Rule",
"options": {
"excludeTypes": null,
"includeTypes": [
"RULE"
],
"objectOptions": {
"RULE": {
"includedIds": [],
"includedNames": [
"Rule JDBCProvision Adapter"
]
}
}
},
"objects": [
{
"version": 1,
"self": {
"name": "Rule JDBCProvision Adapter",
"id": "12ab34c5abcd123aa1b2ab12c3de456e",
"type": "RULE"
},
"object": {
"description": "",
"type": "JDBCProvision",
"signature": {
"input": [],
"output": null
},
"sourceCode": {
"version": "2021-03-16 09:36:34",
"script": "\n\nimport sailpoint.customer.source.rule.ProvisionRule;\n\nlog.debug(\"--Inside Rule Adapter --\");\nreturn ProvisionRule.provision( application, connection, plan, log);\n\n"
},
"attributes": {
"sourceVersion": "2021-03-16 09:36:34"
},
"id": "12ab34c5abcd123aa1b2ab12c3de456e",
"name": "Rule JDBCProvision Adapter",
"created": "2021-03-16T09:36:34.819Z",
"modified": null
},
"jwsHeader": "eyJhbGcJSIudhfmA9zI1NiJ9",
"jwsSignature": "ABCDe1234_pUt6h5rutYqc_1223456ABCDEFG789877879873m1VXh8amkfCOQCzXWt0Gk6jcFJTg3A"
}
]
}

  1. Initiate the JSON Import

API: Initiates Configuration Objects Import Job
Using the file from the JSON export, you can then import the objects into another environment.

Example Request:

POST https://{tenant}.api.identitynow.com/beta/sp-config/import

Content Type : multipart/form-dataBody : Form Data
Key = Data Value = file.json (This is the file in which we saved the response from the last step)

Select type as File and attach the file to import.

NOTE: In Postman, if you change the key type to File, you can then select the file you want to import.

Useful documents