Go to Slack

SCIM API pagination changes for Users and Groups

Published: Tuesday, June 11, 2019
APIs

We're modernizing the GET /Users and GET /Groups methods of our SCIM user management API by putting a more reasonable upper bound on results served per page.

The SCIM spec allows for pagination and these methods have long supported it, but we've accepted higher count values in the past.

The changes described below are effective July 8th, 2019.

What's changing?

The count parameter in GET /Users and GET /Groups will no longer accept values greater than 1000.

HTTP requests with count parameter values of 1001 and above will automatically be evaluated as if 1000 were provided and only the first 1,000 results will be returned. The remainder can be fetched by adjusting the startIndex parameter.

What isn't changing?

The default page size remains 10 results when no count parameter is presented.

No other methods have changed.

How do I prepare?

If you don't use the SCIM API or don't use these two data retrieval methods, there's no action needed, regardless of workspace size.

If you use the SCIM API and provide count values greater than 1000 to these two SCIM methods, you'll need to paginate through the lists provided by GET /Users and GET /Groups using both the count and startIndex parameters.

When is this happening?

This change to count parameters in the SCIM API takes effect on July 8th, 2019.

We don't anticipate this change to negatively effect a large number of workspaces or applications. Talk to us if you have concerns or questions.

Review other recent updates