Overview#
SCIM Read Request is a
SCIM Resource Operation to Read a
SCIM ResourceSCIM Read Request is performed using a URL
endpoint similar to:
GET https://example.com/{v}/{resource}/{id}
Best Practices are for the
URL is that the
URL contains a version number so that different versions of the
SCIM API can co-exist. Available versions can be dynamically discovered via the
SCIM Service Provider Configuration Endpoints.
SCIM Read Request Example#
To create a resource, send an HTTP POST request to the resource's respective end point. In the example below we see the creation of a User.
GET /v2/Users/2819c223-7f76-453a-919d-413861904646
Host: example.com
Accept: application/scim+json
Authorization: Bearer h480djs93hd8
!! Get Response
The response to a
HTTP GET contains the Resource. The
Etag header can, in subsequent requests, be used to prevent concurrent modifications of Resources.
HTTP/1.1 200 OK
Content-Type: application/json
Location: https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646
Etag: W/"e180ee84f0671b1"
{
"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],
"id":"2819c223-7f76-453a-919d-413861904646",
"externalId":"bjensen",
"meta":{
"resourceType":"User",
"created":"2011-08-01T18:29:49.793Z",
"lastModified":"2011-08-01T18:29:49.793Z",
"location":
"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
"version":"W\/\"f250dd84f0671c3\""
},
"name":{ ...
There might be more information for this subject on one of the following: