Configuring Retry Mechanism

Provisioning Retries

Note
For more information on SailPoint's REST APIs, refer to Best Practices: REST API Authentication and REST API - Update Source (Partial) in the SailPoint Developer Community.

SailPoint connectors that support provisioning operations have the ability to retry a failed operation based on configurable error messages.

The retryableErrors entry in the connector configuration is a list of strings that the connector searches for in the error message received from the managed source. If any of the configured error strings are found in the error message, the connector will attempt to retry the provisioning operation.

Add a list of retryable error messages to the attributes map of the source configuration. If the error message contains one of the specified strings, the connector will initiate a retry attempt. However, if the configured error string is not present in the error message, the connector will consider the operation as failed and will not attempt a retry.

Add the following entry in the source XML using the SailPoint REST APIs:

For example,

Use the Identity Security Cloud API by sending a PATCH request to the /v3/sources/{id} endpoint:

PATCH https://{orgName}.api.identitynow.com/v3/sources/:id

In the body of the PATCH, enter the retryable errors as follows:

Copy 
[
    {
        "op": "add",
        "path": "/connectorAttributes/retryableErrors",
        "value": [
            "<error_message_1>",
            "<error_message_2>"
        ]
    }
]

Note
Error messages containing very specific information about date/time, sequence ID and so on must be avoided. Error codes or error message substrings would be good candidates for inclusion.

The Freshservice SaaS connector supports the following attributes to implement retry logic:

This attribute allows you to specify a list of HTTP status codes that should trigger a retry. For example, setting it to [403, 404] will cause the connector to retry the operation when encountering these status codes. By default, the connector will automatically retry on receiving a 429 (Too Many Requests) status code.

In the body of the PATCH, enter the retryable error status code as follows:

Copy 
[
    {
        "op": "add",
        "path": "/connectorAttributes/retryableErrorStatus",
        "value": [
            403,
            404
        ]
    }
]

This attribute defines the maximum number of retry attempts for the specified error codes. The default value is 2, but it can be increased through the source configuration.

In the body of the PATCH, enter the maxRetryOnError as follows:

Copy 
[
    {
        "op": "add",
        "path": "/connectorAttributes/maxRetryOnError",
        "value": 2
    }
]