Overview#
SCIM Create Request is a SCIM Resource Operation to Create an SCIM ResourceSCIM Create 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.As can be seen in this and later examples 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 ServiceProviderConfig end point.
POST /v2/Users HTTP/1.1
Accept: application/json
Authorization: Bearer h480djs93hd8
Host: example.com
Content-Length: ...
Content-Type: application/json
{
"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],
"externalId":"bjensen",
"userName":"bjensen",
"name":{
"familyName":"Jensen",
"givenName":"Barbara"
}
}
Create Response#
A response contains the created Resource and HTTP Status Code HTTP 201 to indicate that the Resource has been created successfully.The SCIM Service Provider has added additional data than was posted to make a complete SCIM User resource:
- The HTTP Header Field "Location"
- The HTTP Header Field Etag
- SCIM id
- SCIM meta
The HTTP Header Field "Location" and SCIM meta.location indicates where the SCIM Resource can be fetched in subsequent requests.
The The HTTP Header Field etag and SCIM meta.lastModified may be used ot determine if the entry was modifies since the last interaction of the SCIM Client
HTTP/1.1 201 Created
Content-Type: application/scim+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-01T21:32:44.882Z",
"lastModified":"2011-08-01T21:32:44.882Z",
"location":"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
"version":"W\/\"e180ee84f0671b1\""
},
"name":{
"familyName":"Jensen",
"givenName":"Barbara"
},
"userName":"bjensen"
}
