Bulk Endpoint

Create/Update/Replace/Delete SCIM Resources (Users/ Groups) in Bulk

Changed on Jul 17, 2026

This API is used to create/update/replace/delete SCIM resources in bulk. You need to specify different operations in the request payload corresponding to the type of bulk update: - POST operation: Adds new resources. - PUT operation: Replaces an existing resource. - PATCH operation: Updates attributes of an existing resource. - DELETE operation: Removes an existing resource.

Scopes required: internal_bulk_resource_create
Flow type: Client Credentials OAuth Flow

post/Bulk

Request

Base URL
https://api.asgardeo.io/t//scim2
Auth
OAuth 2
Client credentials
TypeScript
https://skmtc.dev/ballerina-platform/apis/scim-2-0-api/docs/Bulk/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "failOnErrors": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
  ],
  "Operations": [
    {
      "method": "POST",
      "path": "/Users",
      "bulkId": "ytrewq",
      "data": {
        "schemas": [
          "urn:ietf:params:scim:schemas:core:2.0:User",
          "urn:ietf:params:scim:schemas:enterprise:2.0:User",
          "urn:scim:wso2:schema"
        ],
        "userName": "DEFAULT/kim@gmail.com",
        "password": "Pass@kim1"
      }
    }
  ]
}

Response

Valid user is created

schemasstring[]

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
  ],
  "Operations": [
    {
      "bulkId": "qwerty",
      "method": "POST",
      "location": "https://api.asgardeo.io/t/{org-name}/scim2/Users/81cbba1b-c259-485d-8ba4-79afb03e5bd1"
    }
  ]
}

Changes

Jul 17, 20267978594f207e Revision changes
- breaking
  the /// request property type changed from integer to string
- breaking
  the response's property type changed from object to array for status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
Aug 14, 2025d290ee2c70fc Revision changes
- breaking
  the /// request property type changed from string to integer
- breaking
  the response's property type changed from array to object for status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status

Operation history