> ## Documentation Index
> Fetch the complete documentation index at: https://developers.firstbase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bulk operations

> Performs bulk operations using the SCIM protocol as defined by RFC 7644.



## OpenAPI

````yaml /openapi.json post /scim/v2/Bulk
openapi: 3.1.0
info:
  title: Firstbase API Specification
  description: Integration endpoints for Firstbase
  version: 0.1.0
servers:
  - url: http://localhost:8081
    description: Production
security:
  - ApiKey: []
tags:
  - name: Catalog
    description: Browse SKUs, brands, and categories
  - name: Inventory
    description: Query and manage inventory items and assets
  - name: Inventory Levels
    description: Configure inventory levels by SKU and warehouse
  - name: Inventory Orders
    description: Create and manage inventory orders
  - name: ITAD
    description: IT asset disposition requests
  - name: New Joiners
    description: Track and remind new joiners
  - name: Offices
    description: Manage office locations
  - name: Orders
    description: Create and track equipment orders
  - name: Packages
    description: Manage equipment packages
  - name: People
    description: Provision and manage users
  - name: Regions
    description: Query regions
  - name: Replacements
    description: Create and manage equipment replacements
  - name: Returns
    description: Create and manage returns
  - name: Shipment
    description: Look up shipments and carriers
  - name: Shipment Notices
    description: Create and manage shipment notices
  - name: Warehouses
    description: Query warehouses
paths:
  /scim/v2/Bulk:
    post:
      tags:
        - People
      summary: Bulk operations
      description: Performs bulk operations using the SCIM protocol as defined by RFC 7644.
      operationId: scimBulkOperations
      requestBody:
        content:
          application/scim+json:
            schema:
              type: string
            examples:
              BulkCreateUpdateUsers:
                summary: Create a user and update an existing user
                description: >-
                  SCIM Bulk request that creates a new user and updates an
                  existing one.
                value:
                  schemas:
                    - urn:ietf:params:scim:api:messages:2.0:BulkRequest
                  failOnErrors: 1
                  Operations:
                    - bulkId: bulk-test
                      method: POST
                      path: /Users
                      data:
                        schemas:
                          - urn:ietf:params:scim:schemas:core:2.0:User
                          - >-
                            urn:ietf:params:scim:schemas:extension:firstbase:1.0:User
                        userName: testa@example.com
                        name:
                          givenName: Name
                          familyName: ExampleSurname
                        emails:
                          - value: testa@example.com
                            primary: true
                          - value: testb@email.com
                            primary: false
                        addresses:
                          - type: home
                            primary: true
                            country: US
                            streetAddress: Test address
                            postalCode: '37076'
                            region: test state
                            locality: TN
                        id: 55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc
                        phoneNumbers:
                          - value: '6155555555'
                            primary: true
                        urn:ietf:params:scim:schemas:extension:firstbase:1.0:User:
                          packageId: d41ebe30-279f-41cd-8ag5-7257854d82e5
                          skipUserActivation: true
                          cpfNumber: '87452365895'
                    - method: PUT
                      path: /Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03
                      data:
                        schemas:
                          - urn:ietf:params:scim:schemas:core:2.0:User
                          - >-
                            urn:ietf:params:scim:schemas:extension:firstbase:1.0:User
                        userName: dev+admin@firstbasedev.com
                        name:
                          givenName: Test Given Name
                          familyName: Test familyName
                        emails:
                          - value: test+swaggera@firstbasedev.com
                            primary: true
                          - value: test+swaggerb@firstbasedev.com
                            primary: false
                        addresses:
                          - type: home
                            primary: true
                            country: US
                            streetAddress: 'Test address '
                            postalCode: '37076'
                            region: test state
                            locality: TN
                        id: 4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03
                        phoneNumbers:
                          - value: '6155555555'
                            primary: true
                        urn:ietf:params:scim:schemas:extension:firstbase:1.0:User:
                          packageId: d82ebe36-299f-40ce-8af7-7157853d80d9
                          skipUserActivation: true
                          cpfNumber: '87452365895'
        required: true
      responses:
        '200':
          description: Bulk operation completed
          content:
            application/scim+json:
              schema:
                type: string
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl -sS -X POST 'http://localhost:8081/scim/v2/Bulk' \
              -H 'Authorization: ApiKey YOUR_API_KEY' \
              -H 'Accept: application/json' \
              -H 'Content-Type: application/scim+json' \
              -d '{
                "schemas": [
                  "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
                ],
                "failOnErrors": 1,
                "Operations": [
                  {
                    "bulkId": "bulk-test",
                    "method": "POST",
                    "path": "/Users",
                    "data": {
                      "schemas": [
                        "urn:ietf:params:scim:schemas:core:2.0:User",
                        "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
                      ],
                      "userName": "testa@example.com",
                      "name": {
                        "givenName": "Name",
                        "familyName": "ExampleSurname"
                      },
                      "emails": [
                        {
                          "value": "testa@example.com",
                          "primary": true
                        },
                        {
                          "value": "testb@email.com",
                          "primary": false
                        }
                      ],
                      "addresses": [
                        {
                          "type": "home",
                          "primary": true,
                          "country": "US",
                          "streetAddress": "Test address",
                          "postalCode": "37076",
                          "region": "test state",
                          "locality": "TN"
                        }
                      ],
                      "id": "55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc",
                      "phoneNumbers": [
                        {
                          "value": "6155555555",
                          "primary": true
                        }
                      ],
                      "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
                        "packageId": "d41ebe30-279f-41cd-8ag5-7257854d82e5",
                        "skipUserActivation": true,
                        "cpfNumber": "87452365895"
                      }
                    }
                  },
                  {
                    "method": "PUT",
                    "path": "/Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
                    "data": {
                      "schemas": [
                        "urn:ietf:params:scim:schemas:core:2.0:User",
                        "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
                      ],
                      "userName": "dev+admin@firstbasedev.com",
                      "name": {
                        "givenName": "Test Given Name",
                        "familyName": "Test familyName"
                      },
                      "emails": [
                        {
                          "value": "test+swaggera@firstbasedev.com",
                          "primary": true
                        },
                        {
                          "value": "test+swaggerb@firstbasedev.com",
                          "primary": false
                        }
                      ],
                      "addresses": [
                        {
                          "type": "home",
                          "primary": true,
                          "country": "US",
                          "streetAddress": "Test address ",
                          "postalCode": "37076",
                          "region": "test state",
                          "locality": "TN"
                        }
                      ],
                      "id": "4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
                      "phoneNumbers": [
                        {
                          "value": "6155555555",
                          "primary": true
                        }
                      ],
                      "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
                        "packageId": "d82ebe36-299f-40ce-8af7-7157853d80d9",
                        "skipUserActivation": true,
                        "cpfNumber": "87452365895"
                      }
                    }
                  }
                ]
              }'
components:
  schemas:
    PublicApiHttpErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiError'
          description: List of error details.
      required:
        - errors
    PublicApiError:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable description of the error
          example: Invalid request
        source:
          type: string
          description: >-
            Entity or field path that caused the error (for example order,
            shipmentNotice, or person:email)
          example: request
      required:
        - detail
        - source
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Prefix the value with "ApiKey" to indicate the custom authorization type
      name: Authorization
      in: header

````