POST, PUT, PATCH Requests

POST, PUT, and PATCH requests require a JSON request body.

The following is an example of a JSON request body used with a POST method to create a user:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "bypassNotification": true,
    "name": {
        "givenName": "Barbara",
        "familyName": "Jensen"
    },
    "userName": "bjensen",
    "emails": [
        {
            "value": "bjensen@exmple.com",
            "type": "work",
            "primary": true
        },
        {
            "value": "bjenson@exmple.com",
            "primary": false,
            "type": "recovery"
        }
    ]
}
Note

  • The schemas attribute is set to the schema collection that corresponds with the resource, in this case urn:ietf:params:scim:schemas:core:2.0:User, which corresponds with /Users. See SCIM Schema Overview.

  • The remaining attributes are user attributes to be set.

You can find more examples of JSON request bodies in topics describing POST, PUT, and PATCH requests.