This page (revision-1) was last changed on 29-Nov-2024 16:16 by UnknownAuthor

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note

Page References

Incoming links Outgoing links
SCIM Pagination
SCIM Pagination

Version management

Difference between version and

At line 1 added 49 lines
!!! Overview
[{$pagename}] parameters can be used together to "page through" large numbers of [SCIM Resources] so as not to overwhelm the [SCIM Client] or [SCIM Service Provider].
[{$pagename}] is not session based hence Consumers SHOULD never assume repeatable results. For example, a request for a list of 10 Resources beginning with a startIndex of 1 may return different results when repeated as a Resource in the original result could be deleted or new ones could be added in-between requests. Pagination parameters and general behavior are derived from the OpenSearch Protocol.
The following table describes the [URL] pagination parameters.
%%zebra-table
%%sortable
%%table-filter
||Parameter||Description||Default
|startIndex|The 1-based index of the first search result.|1
|count|Non-negative Integer. Specifies the desired maximum number of search results per page; e.g., 10.|None. When specified the Service Provider __MUST__ not return more results than specified though __MAY__ return fewer results. If unspecified, the maximum number of results is set by the Service Provider.
/%
/%
/%
The following table describes the query response pagination attributes specified by the [SCIM Service Provider].
%%zebra-table
%%sortable
%%table-filter
||Element||Description
|itemsPerPage|Non-negative Integer. Specifies the number of search results returned in a query response page; e.g., 10.
|totalResults|Non-negative Integer. Specifies the total number of results matching the Consumer query; e.g., 1000.
|startIndex|The 1-based index of the first result in the current set of search results; e.g., 1.
/%
/%
/%!! [{$pagename}] [Example]
For example, to retrieve the first 10 Users set the startIndex to 1 and the count to 10.
%%prettify
{{{
GET /Users?startIndex=1&count=10
Host: example.com
Accept: application/json
Authorization: Bearer h480djs93hd8
{
"totalResults":100,
"itemsPerPage":10,
"startIndex":1,
"schemas":["urn:scim:schemas:core:1.0"],
"Resources":[{
...
}]
}
}}}} /%
Given the example above, to continue paging set the startIndex to 11 and re-fetch; i.e., /Users?startIndex=11&count=10
!! More Information
There might be more information for this subject on one of the following:
[{ReferringPagesPlugin before='*' after='\n' }]
This page (revision-1) was last changed on 29-Nov-2024 16:16 by UnknownAuthorTop