Skip to content

Update UPS API timeouts and strengthen PATCH vs PUT guidance #1786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
smrithijayarajan wants to merge 1 commit into from
Closed

Update UPS API timeouts and strengthen PATCH vs PUT guidance #1786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions src/api-reference/user-provisioning/v4.user-provisioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,10 @@ The following guidelines outline the best practices for working with the SAP Con
### Key Recommendations

* Use the `/Bulk/` endpoint for batch operations (up to 100 operations per request) and `/Users/` for single-user operations.
* Use `PATCH` operations instead of `PUT` for regular user updates to minimize error rates.
* Use `PATCH` operations instead of `PUT` for regular user updates to minimize data loss risk.
* Track provision completion using the `provisionId` returned in the response, either via polling (with exponential backoff) or webhook notifications.
* Pre-validate data before submission — most failures are caused by data validation issues.
* When identity extensions fail, retry the entire operation after fixing the issue. When spend/travel extensions fail, retry only those extensions via a subsequent `PATCH` request.
* There is a 240-minute provision request timeout; please reach out to us with the `provisionId` if requests remain pending for an extended period.

### When to Use Each Endpoint

Expand All @@ -81,7 +80,7 @@ The following guidelines outline the best practices for working with the SAP Con

### Operations Best Practices

For regular user updates, use `PATCH` operations rather than `PUT` (full replace), whether for single user requests or bulk operations. This is the approach used by our large enterprise customers handling thousands of daily updates.
Use `PUT` only for initial user creation (or intentional full replacement of a user). Use `PATCH` for **ALL** incremental user updates. Reissuing `PUT` overwrites the user and removes all previous edits. This is critical: large enterprise customers handling thousands of daily updates exclusively use `PATCH` to avoid unintended data loss.

#### For bulk updates (HR sync, daily changes)

Expand Down Expand Up @@ -283,11 +282,7 @@ Use `/swagger` endpoint to retrieve the schema for error codes and messages at e

### Handling Long Pending Provision Requests

Currently the timeout for each provision request is 240 minutes. The provision request is marked as failure by the system if it exceeds the timeout.

If you have a provision request that is pending for a long time, please reach out to us with the `provisionId` for investigation. The operation can be retried after the timeout based on the failure scenarios mentioned above.

> **Note:** We have plans to reduce this timeout under 60 minutes.
Currently the timeout for each provision request is **120 minutes** (60 minutes in CCPS environments). The provision request is marked as failure by the system if it exceeds the timeout. The operation can be retried after the timeout based on the failure scenarios mentioned above.


## <a name="event-usage"></a>Events
Expand Down