The bulk request that clients use to send a potentially large collection of resource operations in a single request. For a PUT, PATCH, or POST, the data in the operation is the resource data as for a single SCIM request.

Entitlement required: manageUserGroups (Manage users and groups) or manageAllUserGroups (Synchronize users and groups) or manageUserStandardGroups (Manage users and standard groups), or manageUsers (Manage all users), or manageUsersInStandardGroups (Manage users in standard groups), or manageGroups (Manage all groups but not their members), or manageStandardGroups (Manage standard groups but not their members), or manageGroupMembers (Manage all group and their members), or manageStandardGroupMembers (Manage standard groups and their members).
Note: You only need one entitlement, but you can have more than one.

The maximum number of operations is 1000 and the maximum payload size is 1048576.

By default, an email is sent to the users that are created, modified, deleted, and added or removed as a member of a group. The email templates for branding are at "notifications/user_management/profile/" and "notifications/user_management/group/".
Pass in the themeId query parameter to brand the email template for notifications.
To turn off email notifications, send notifyType=NONE as a query parameter.

An example bulk request payload:

{ "schemas":["urn:ietf:params:scim:api:messages:2.0:BulkRequest"],"Operations":[ { "method":"POST", "bulkId":"qwerty0", "path":"/Users", "data":{ "schemas":["urn:ietf:params:scim:schemas:core:2.0:User"], "userName":"tim_mo", "emails":[{ "type":"work", "value":"tim_mo@mailinator.com" }] } }, { "method":"POST", "bulkId":"qwerty1", "path":"/Users", "data":{ "schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:ibm:2.0:User"], "userName":"bulkUser2@www.realm.com", "urn:ietf:params:scim:schemas:extension:ibm:2.0:User":{ "userCategory":"federated" } } }, { "method":"POST", "path":"/Groups", "bulkId":"qwerty2", "data": { "schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"], "displayName":"mygroup", "members":[ {"type":"user", "value":"bulkId:qwerty0"}, {"type":"user", "value":"bulkId:qwerty1"}, {"type":"user", "value":"501X123JRS"} ] } }, { "method":"DELETE", "path":"/Users/500EPPJQCS" }]}

Query Params
string

An optional query parameter that denotes the notification type. If not present, the EMAIL notification is used. Specify NONE if no notification to the user is required.

string

The identifier of the theme that you want to apply.

Body Params

The bulk request payload.

array of strings
required

An array of strings that contain the URIs that indicate the namespaces of the SCIM schemas that define the attributes in the current JSON structure. The schema URI must be "urn:ietf:params:scim:api:messages:2.0:BulkRequest" as required by the SCIM specification.

schemas*
int32

An integer that specifies the number of errors that the service provider accepts before the operation is terminated and an error response is returned.

array of objects
required

Defines the operations within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint.

Operations*
Headers
string
Defaults to false

If set to true, the user is not required to change the password after login.
Only honored if the user's password is provided in the bulk request.

Responses

Language
URL
Choose an example:
application/scim+json