Retry Configurations

Provisioning Retry Errors

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.

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.

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.

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

For example,

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.

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.

Maximum Retry Count

The maxRetryCount parameter enables you to configure the maximum number of attempts the connector retries a failing operation before terminating it.

Sets the maximum number of attempts before terminating a failing operation.

Integer

Default: 2

Set the parameter as follows using the REST API:

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

In the body of the PATCH, enter the maximum retry count as follows:

Copy 
[
    {
        "op": "add",
        "path": "/connectorAttributes/maxRetryCount",
        "value": <required_value>
    }
]

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.

Wait Time Before Retry

Use the waitTimeBeforeRetry to configure the duration of time in seconds that the connector waits before retrying a failed operation.

Sets the wait time in seconds

The default value is null. The connector retries failed attempts immediately.

Set the parameter as follows using the REST API:

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

In the body of the PATCH, enter the maximum retry count as follows:

Copy 
[
    {
        "op": "add",
        "path": "/connectorAttributes/waitTimeBeforeRetry",
        "value": <required_value>
    }
]

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.