Skip to content

Retry Configurations

Important

Add a list of retryable error messages to the attributes map of the source configuration. The value must be specified as a list or array even when only a single error string is provided.

Provisioning Retry Errors

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. The value must be specified as a list or array even when only a single error string is provided. 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 SailPoint 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:

[
    {
        "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.

Aggregation Retry Errors

Aggregation retries can be set up for each source by configuring the aggregationRetryErrors attribute under the connectorAttributes section.

Send 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 aggregationRetryErrors as follows:

{
    "op": "add",
    "path": "/connectorAttributes/aggregationRetryErrors",
    "value": ["Connection reset"]
}

In addition to specifying the aggregation retry errors, you can also configure the following options:

retryWaitTime

A string specifying the amount of time (in milliseconds) to wait before attempting a retry. The default value is 5000 milliseconds (5 seconds).

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

{
    "op": "add",
    "path": "/connectorAttributes/retryWaitTime",
    "value": "5000"
}
maxRetryCount

A string defining the maximum number of retry attempts that will be performed. The default value is 3.

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

{
    "op": "add",
    "path": "/connectorAttributes/maxRetryCount",
    "value": "3"
}

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.