Bulk endpoint
Bulk endpoint¶
This endpoint allows you to create, edit or delete multiple users within a single bulk request and it is exposed in the path:
<api-root>/scim/v2/Bulk
Operations¶
| Operation | Http Method | Request Body | Path Variable | Query String Parameters | Response Body | HTTP Response Status | Response Status (SCIM Exception) |
|---|---|---|---|---|---|---|---|
| Bulk | POST | BulkRequest | - | - | BulkResponse | 200 (OK) | 400 (Bad Request) |
SCIM Exceptions¶
Invocation examples
| HTTP Status | Descriptions |
|---|---|
| 400 (Bad Request) | It occurs when the bulk request does not match the service specification, for example invoking it providing the same bulk id to more than one operation inside the bulk request or missing some required attribute. |
Supported BulkRequest fields¶
The supported standard SCIM User fields are listed in the following table.
| SCIM User field | Supported cardinality (for collection only) | Supported values |
|---|---|---|
| Operations | 1..* | - |
Operations fields¶
The supported standard SCIM Operations fields are listed in the following table. Not all the SCIM Operations standard fields are currently supported by CCH Tagetik.
| SCIM User field | Supported cardinality (for collection only) | Supported values |
|---|---|---|
| method | 1..* | - |
| bulkId | - | - |
| path | - | - |
| data | - | - |
| location | - | - |
| response | - | - |
| status | - | - |
Examples¶
| List all users | |
|---|---|
| Method | POST |
| URL | <api-root>/scim/v2/Bulk |
| Body | { "schemas": ["urn:ietf:params:scim:api:messages:2.0:BulkRequest"], "Operations": [{ "method": "POST", "path": "/Users", "bulkId": "1", "data": { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], "externalId": "testUser1", "userName": "testUser1", "name": { "familyName": "testUser1", "givenName": "testUser1" }, "urn:tgk:params:scim:schemas:extension:2.0:User": { "userReferences": ["TAGETIK"] } } },{ "method": "POST", "path": "/Users", "bulkId": "2", "data": { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], "externalId": "testUser2", "userName": "testUser2", "name": { "familyName": "testUser1", "givenName": "testUser1" }, "urn:tgk:params:scim:schemas:extension:2.0:User": { "userReferences": ["TAGETIK"] } } },{ "method": "DELETE", "path": "/Users/testUser3" }]} |
| Sample Response | { "schemas": ["urn:ietf:params:scim:api:messages:2.0:BulkResponse"], "Operations": [ { "method": "POST", "bulkId": "1", "location": "/Users/testUser1", "status": "201" },{ "method": "POST", "bulkId": "2", "location": "/Users/testUser2", "status": "201" },{ "method": "DELETE", "location": "/Users/testUser3", "status": "200" } ] } |
| Notes | This call combines two user creations (testUser1, testUser2) and one deletion (testUser3). |