Bulk

URI ® urn:scim:schemas:core:2.0:BulkRequest/BulkResponse

Bulk requests and bulk responses share many attributes. Unless otherwise specified, each attribute below is present in both bulk requests and bulk responses.

Table 3-6 Supported SCIM Schema Attributes for Bulk

SCIM Attribute	Constraint: Uniqueness	Constraint: Required	Description
failOnErrors	None	False	An integer specifying the number of errors allowed before the operation is terminated and an error response is returned. Only the operations that are processed until the failOnErrors limit is reached are returned in the BulkResponse. The rest of the operations are ignored. Optional in a request. Not valid in a response.
Operations	None	True	Complex multivalued attribute.
Operations.method	None	True	The HTTP method of the current operation. Possible values are: POST, PUT, PATCH, or DELETE for User operations. PATCH for Group operations.
Operations.bulkId	Must be unique within a bulk request.	False	The bulkId is a surrogate resource ID, enabling clients to uniquely identify newly created resources in the response and to cross-reference new resources in and across operations within a bulk request. Required when method is POST.
Operations.path	None	True	The relative path of the resource. If the method is POST, the value must specify a resource type endpoint (for example, /Users). All other method values must specify the path to a specific resource (for example, /Users/2819c2237f76453a919d)
Operations.data	None	True for all except the DELETE method.	The resource data for the bulk POST, PUT, or PATCH resource operation as a single request.
Operations.location	None	True for response.	The resource endpoint URL. Required in a response, except in the event of a POST failure.
Operations.status	None	True for response.	A complex type that contains information about the success or failure of one operation within the bulk request. Required in a response.
Operations.status.code	None	True for response.	The HTTP response code returned for the bulk operation as a single request. Required.
Operations.status.description	None	False	A human-readable error message. Required when an error occurs.