The operations are specified by adding query parameters to the Resource's endpoint. SCIM Service Providers MAY support additional query parameters not specified here, and SCIM Service Providers SHOULD ignore any query parameters they don't recognize.
GET /Users?attributes=userName Host: example.com Accept: application/json Authorization: Bearer h480djs93hd8
Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"totalResults":2,
"schemas":["urn:scim:schemas:core:1.0"],
"Resources":[
{
"userName":"bjensen"
},
{
"userName":"jsmith"
}
]
}
In addition to filtering the response it is also possible to ask the service provider to sort the Resources in the response, return specific attributes of the resources, and return only a subset of the resources. The syntax for the request is:
https://example.com/{resource}?filter={attribute} {op} {value} & sortBy={attributeName}&sortOrder={ascending|descending}&attributes={attributes}
A typical Filter Request URL might be for Title=pr and userType=Employee:
https://example.com/Users?filter=title pr and userType eq “Employee”__&sortBy__=title&sortOrder=ascending&attributes=title,username
{
"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults":2,
"Resources":[
{
"id":"c3a26dd3-27a0-4dec-a2ac-ce211e105f97",
"title":"Assistant VP",
"userName":"bjensen"
},
{
"id":"a4a25dd3-17a0-4dac-a2ac-ce211e125f57",
"title":"VP",
"userName":"jsmith"
}
]
}