Configuring Retry Errors

The Microsoft Entra SaaS connector can automatically retry failed error messages and error codes when the connector encounters a transient error. This is configured by adding error messages to the source's connector attributes list using the REST API.

When an error occurs, the connector checks the error message against a configured list of strings. If any string matches, the operation is retried automatically instead of failing immediately.

Retry errors are configured by adding connector attributes to the source using the REST API.

API endpoint:

<PATCH https://{tenant}.api.identitynow.com/v3/sources/{sourceId}>

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.

Prerequisites

  • The admin needs REST API access and the source ID.

  • To find your source ID, go to Admin > Sources > [Your Source]. The ID appears in the browser URL. For API authentication, refer to REST API Authentication.

Adding Retry Error Messages

To configure retries for failed error messages, add the retryableErrorMessages attribute as shown below:

Copy 
[
  {
    "op": "add",
    "path": "/connectorAttributes/retryableErrorMessages",
    "value": [ "Failed to execute" , "backend request"]
  }
]

Adding Retry Error Codes

To configure retries for failed error codes, add the retryableErrorCodes attribute as shown below:

Copy 
[
  {
    "op": "add",
    "path": "/connectorAttributes/retryableErrorCodes",
    "value": "502,409"
  }
]

Adding the retryDelay Attribute

To set the delay between retry attempts, add the retryDelay attribute as shown below. The default is 1000. You can increase the value to a maximum of 5000.

Copy 
[
  {
    "op": "add",
    "path": "/connectorAttributes/retryDelay",
    "value": 2000
  }
]

Adding the maxRetryCount Attribute

To set the maximum number of retry attempts, add the maxRetryCount attribute as shown below. The default is 3. You can increase the value to a maximum of 5.

Copy 
[
  {
    "op": "add",
    "path": "/connectorAttributes/maxRetryCount",
    "value": 4
  }
]