Execute Bulk

Execute Bulk
Execute bulk delete operations

Deletes multiple users and/or groups in a single request. Only DELETE method is supported. Max 20 operations per request. All operations are processed regardless of individual failures. RFC 7644: https://tools.ietf.org/html/rfc7644#section-3.7

Request
URI
POST
https://{api_host}/usergroup/t/{tenant}/scim/v2/Bulk
COPY
Path Parameters
string
tenant
Required  

The VMware Identity Services tenant ID

tenant example
my-tenant
Request Body
BulkRequestMedia of type(s) application/scim+json
Required  

Show optional properties

{
    "schemas": [
        {}
    ],
    "Operations": [
        {
            "method": "DELETE",
            "path": "/Users/2819c223-7f76-453a-919d-413861904646"
        }
    ]
}
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
    ],
    "Operations": [
        {
            "method": "DELETE",
            "path": "/Users/2819c223-7f76-453a-919d-413861904646"
        }
    ]
}
array of string
schemas
Required  

SCIM schema URIs

array of object
Operations
Required  
Constraints: minItems: 0 maxItems: 20

List of bulk operations (max 20). Each must be a DELETE.

Authentication
This operation uses the following authentication methods.
Responses
200

Bulk operation completed. Per-operation status in body.

Returns BulkResponseMedia of type(s) application/scim+json 
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
    ],
    "Operations": [
        {
            "method": "DELETE",
            "location": "https://host/usergroup/t/tenant1/scim/v2/Users/2819c223-7f76-453a-919d-413861904646",
            "status": "204",
            "response": {
                "schemas": [
                    "string"
                ],
                "scimType": "mutability",
                "detail": "User not found: 2819c223-7f76-453a-919d-413861904646",
                "status": "404"
            }
        }
    ]
}

400

Invalid bulk request (bad schema, unsupported method, invalid path).

Operation doesn't return any data structure

413

Too many operations (max 20).

Operation doesn't return any data structure

500

Unexpected error.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/scim+json' -d '{"Operations":["object"],"schemas":["string"]}' https://{api_host}/usergroup/t/{tenant}/scim/v2/Bulk
On This Page
Scim2 Operations
POST
Execute Bulk