Failures in the explore of SCIM based endpoint due to IM requesting result above totalResult value.
search cancel

Failures in the explore of SCIM based endpoint due to IM requesting result above totalResult value.

book

Article ID: 387855

calendar_today

Updated On:

Products

CA Identity Manager CA Identity Suite

Issue/Introduction

startIndex=<value above totalResults X> (example 101)
count=<pagination number> (10, 100, 1000 etc)
totalResults=X (example 100)

In the log we can see request to SCIM endpoint:

<scim endpoint name> (SCIMAttributeStyleOpProcessor.java:1599) DEBUG - URL: GET https://<hostname of scim endpoint>/user-management/api/scim/Users?attributes=userName&startIndex=<value above totalResults X>&count=<pagination number>HTTP/1.1

<scim endpoint name> (SCIMAttributeStyleOpProcessor.java:1539) WARN - Search with URL https://<hostname of scim endpoint>/user-management/api/scim/Users?attributes=userName&startIndex=<value above totalResults X>&count=<pagination number>failed with error 504:Gateway Time-out

Environment

14.X

Cause

In this case endpoint was unable to return results in case of query that returned 0 results and was suppsoedly seen as incorrect by server, it was not.

Resolution

As per RFC:

https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4

 A query that does not return any matches SHALL return success (HTTP   status code 200) with "totalResults" set to a value of 0.

We perform request above totalResults to make sure all results are returned by the endpoint.