---
title: SCIM Bulk API
path: reference/api/scim-bulk
status: published
---

# SCIM Bulk API

Reference for the `SCIM Bulk` endpoint group — 1 endpoints.

Generated from the live OpenAPI spec. Re-run `_generate_api_reference.py` after backend changes.

## Authentication

All endpoints require a Bearer JWT in the `Authorization` header unless noted otherwise. See [Concepts → Tokens and scopes](/docs/scaikey/concepts/tokens-and-scopes) and [Reference → OAuth endpoints](/docs/scaikey/reference/oauth-endpoints) for how to obtain one.

## Endpoints

### **POST** `/api/v1/tenants/{tenant_id}/scim/v2/Bulk`

_Bulk Operation_

Execute multiple SCIM operations in a single request.

RFC 7644 Section 3.7 - Bulk Operations.

**Parameters:**

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `tenant_id` | path | yes | `string` |  |

**Request body:**

Required.

- `application/json` → [`SCIMBulkRequest`](#schema-scimbulkrequest)

**Responses:**

| Status | Body |
|---|---|
| `200` | `application/json` → [`SCIMBulkResponse`](#schema-scimbulkresponse) |
| `422` | `application/json` → [`HTTPValidationError`](#schema-httpvalidationerror) |

---

## Schemas

Definitions for every type referenced by the endpoints above. Schema-to-schema references on this page link within the page; cross-page references would require visiting the linked page.

### `HTTPValidationError`

| Field | Type | Required | Description |
|---|---|---|---|
| `detail` | array of [`ValidationError`](#schema-validationerror) | no |  |

### `SCIMBulkOperation`

SCIM Bulk operation (RFC 7644 Section 3.7).

| Field | Type | Required | Description |
|---|---|---|---|
| `method` | `string` | yes |  |
| `bulkId` | `string` \| `null` | no |  |
| `version` | `string` \| `null` | no |  |
| `path` | `string` | yes |  |
| `data` | object \| `null` | no |  |

### `SCIMBulkRequest`

SCIM Bulk request.

| Field | Type | Required | Description |
|---|---|---|---|
| `schemas` | array of `string` | no | Default: `['urn:ietf:params:scim:api:messages:2.0:BulkRequest']` |
| `failOnErrors` | `integer` \| `null` | no |  |
| `Operations` | array of [`SCIMBulkOperation`](#schema-scimbulkoperation) | yes |  |

### `SCIMBulkResponse`

SCIM Bulk response.

| Field | Type | Required | Description |
|---|---|---|---|
| `schemas` | array of `string` | no | Default: `['urn:ietf:params:scim:api:messages:2.0:BulkResponse']` |
| `Operations` | array of [`SCIMBulkResponseOperation`](#schema-scimbulkresponseoperation) | yes |  |

### `SCIMBulkResponseOperation`

SCIM Bulk response operation.

| Field | Type | Required | Description |
|---|---|---|---|
| `method` | `string` | yes |  |
| `bulkId` | `string` \| `null` | no |  |
| `version` | `string` \| `null` | no |  |
| `location` | `string` \| `null` | no |  |
| `status` | `string` | yes |  |
| `response` | object \| `null` | no |  |

### `ValidationError`

| Field | Type | Required | Description |
|---|---|---|---|
| `loc` | array of `string` \| `integer` | yes |  |
| `msg` | `string` | yes |  |
| `type` | `string` | yes |  |