Delete SCIM users
DELETE /v1/api/scim/users/{domain_id}.json
Operation id: deleteSCIMUsers
Description
Deletes users after id_token validation (USER_DELETE). Multipart body; same fields as delete external users. Send idempotency-key to make retries safe.
Tags: SCIM Users
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
domain_id | string | Yes | External domain identifier |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id_token | string | Yes | OIDC identity token (id_token) |
Header parameters
| Name | Type | Required | Description |
|---|---|---|---|
idempotency-key | string | No | Optional but recommended client-supplied unique identifier for a write request. Used by save / delete endpoints to make retries idempotent. Use a UUID v4 or similar. |
Responses
200 — List of transaction statuses
Content type: application/json
400 — One or more request parameters are invalid.
Content type: application/json
401 — Authentication failed. The request is missing a token, the token is invalid, or the token has expired.
Content type: application/json
403 — User lacks the required permission for this operation.
Content type: application/json
500 — An unexpected error occurred while processing the request.
Content type: application/json
Request body
Required: Yes
multipart/form-data
Schema
| Property | Type | Required | Description |
|---|---|---|---|
data_load_details | string (binary) | No | |
user_ids_to_delete | string | No | Comma-separated user IDs to delete. |
{
"type": "object",
"properties": {
"data_load_details": {
"type": "string",
"format": "binary"
},
"user_ids_to_delete": {
"type": "string",
"description": "Comma-separated user IDs to delete."
}
}
}
Response models
200 — List of transaction statuses
Content type: application/json
Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"status_code": {
"type": "integer"
},
"meta_info": {
"type": "object"
},
"message": {
"type": "string"
}
}
}
}
400 — One or more request parameters are invalid.
Content type: application/json
Schema
Structured error envelope returned by external gateway endpoints (/v1/api/*). Wraps a single error object with type, code, human-readable message, the offending param (when applicable), and an optional documentation URL.
| Property | Type | Required | Description |
|---|---|---|---|
error | object | No |
{
"type": "object",
"description": "Structured error envelope returned by external gateway endpoints (`/v1/api/*`).\nWraps a single `error` object with `type`, `code`, human-readable `message`, the offending\n`param` (when applicable), and an optional documentation URL.\n",
"properties": {
"error": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "High-level error category (for example `unauthorized`, `invalid_parameter`, `validation_error`).",
"example": "invalid_parameter"
},
"code": {
"type": "string",
"description": "Machine-readable error code; clients should branch on this rather than `message`.",
"example": "invalid_parameter"
},
"message": {
"type": "string",
"description": "Human-readable description of the error.",
"example": "One or more request parameters are invalid."
},
"param": {
"type": "string",
"description": "Name of the request parameter or field that caused the error, when applicable.",
"example": "page_number",
"nullable": true
},
"doc_url": {
"type": "string",
"description": "Optional URL to documentation describing the error.",
"example": "https://{APP_URL}/kernel/errors/invalid_parameter",
"nullable": true
}
}
}
}
}
401 — Authentication failed. The request is missing a token, the token is invalid, or the token has expired.
Content type: application/json
Schema
Structured error envelope returned by external gateway endpoints (/v1/api/*). Wraps a single error object with type, code, human-readable message, the offending param (when applicable), and an optional documentation URL.
| Property | Type | Required | Description |
|---|---|---|---|
error | object | No |
{
"type": "object",
"description": "Structured error envelope returned by external gateway endpoints (`/v1/api/*`).\nWraps a single `error` object with `type`, `code`, human-readable `message`, the offending\n`param` (when applicable), and an optional documentation URL.\n",
"properties": {
"error": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "High-level error category (for example `unauthorized`, `invalid_parameter`, `validation_error`).",
"example": "invalid_parameter"
},
"code": {
"type": "string",
"description": "Machine-readable error code; clients should branch on this rather than `message`.",
"example": "invalid_parameter"
},
"message": {
"type": "string",
"description": "Human-readable description of the error.",
"example": "One or more request parameters are invalid."
},
"param": {
"type": "string",
"description": "Name of the request parameter or field that caused the error, when applicable.",
"example": "page_number",
"nullable": true
},
"doc_url": {
"type": "string",
"description": "Optional URL to documentation describing the error.",
"example": "https://{APP_URL}/kernel/errors/invalid_parameter",
"nullable": true
}
}
}
}
}
403 — User lacks the required permission for this operation.
Content type: application/json
Schema
Structured error envelope returned by external gateway endpoints (/v1/api/*). Wraps a single error object with type, code, human-readable message, the offending param (when applicable), and an optional documentation URL.
| Property | Type | Required | Description |
|---|---|---|---|
error | object | No |
{
"type": "object",
"description": "Structured error envelope returned by external gateway endpoints (`/v1/api/*`).\nWraps a single `error` object with `type`, `code`, human-readable `message`, the offending\n`param` (when applicable), and an optional documentation URL.\n",
"properties": {
"error": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "High-level error category (for example `unauthorized`, `invalid_parameter`, `validation_error`).",
"example": "invalid_parameter"
},
"code": {
"type": "string",
"description": "Machine-readable error code; clients should branch on this rather than `message`.",
"example": "invalid_parameter"
},
"message": {
"type": "string",
"description": "Human-readable description of the error.",
"example": "One or more request parameters are invalid."
},
"param": {
"type": "string",
"description": "Name of the request parameter or field that caused the error, when applicable.",
"example": "page_number",
"nullable": true
},
"doc_url": {
"type": "string",
"description": "Optional URL to documentation describing the error.",
"example": "https://{APP_URL}/kernel/errors/invalid_parameter",
"nullable": true
}
}
}
}
}
500 — An unexpected error occurred while processing the request.
Content type: application/json
Schema
Structured error envelope returned by external gateway endpoints (/v1/api/*). Wraps a single error object with type, code, human-readable message, the offending param (when applicable), and an optional documentation URL.
| Property | Type | Required | Description |
|---|---|---|---|
error | object | No |
{
"type": "object",
"description": "Structured error envelope returned by external gateway endpoints (`/v1/api/*`).\nWraps a single `error` object with `type`, `code`, human-readable `message`, the offending\n`param` (when applicable), and an optional documentation URL.\n",
"properties": {
"error": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "High-level error category (for example `unauthorized`, `invalid_parameter`, `validation_error`).",
"example": "invalid_parameter"
},
"code": {
"type": "string",
"description": "Machine-readable error code; clients should branch on this rather than `message`.",
"example": "invalid_parameter"
},
"message": {
"type": "string",
"description": "Human-readable description of the error.",
"example": "One or more request parameters are invalid."
},
"param": {
"type": "string",
"description": "Name of the request parameter or field that caused the error, when applicable.",
"example": "page_number",
"nullable": true
},
"doc_url": {
"type": "string",
"description": "Optional URL to documentation describing the error.",
"example": "https://{APP_URL}/kernel/errors/invalid_parameter",
"nullable": true
}
}
}
}
}