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"], 
  "password": "Password", 
  "userName": "bjensen", 
  "externalId": "barbara.jensen", 
  "name": { "formatted": "Ms. Barbara J Jensen III", 
            "familyName": "Jensen", 
            "givenName": "Barbara"
}
}
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.