Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.
## OpenAPI ````json DELETE /api/2.0/building-blocks/{envId} { "openapi": "3.0.3", "info": { "title": "Management APIs", "version": "1.0.0", "contact": { "name": "PlainID", "url": "https://plainid.com", "email": "contact@plainid.com" }, "license": { "name": "Commercial", "url": "https://plainid.com/license" }, "termsOfService": "https://www.plainid.com/terms/", "description": "| Region | Base URL |
|---|---|
| United States (US) | https://api.us1.plainid.io |
| Canada (CA) | https://api.ca1.plainid.io |
| Europe (EU) | https://api.eu1.plainid.io |
| Local PAA | https://api.plainid.local |
Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.
", "operationId": "deleteBuildingBlockByFilter", "parameters": [ { "in": "path", "name": "envId", "required": "true", "schema": { "type": "string", "format": "uuid" }, "description": "The Environment ID can be found under the Details Tab in the Environment Settings." }, { "in": "query", "name": "filter[authWsId]", "description": "Authorization Workspace ID. This can be found in your Authorization Workspace Settings under Workspace ID. *Required if `identityWsId` is not provided.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "filter[identityWsId]", "description": "Identity Workspace ID. *Required if `authWsId` is not provided.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "filter[kind]", "description": "Kinds of Building Block Filters. *Required if at least one of the following filters are provided:`filter[id]`, `filter[name]`,`filter[templateId]`.", "required": "true", "schema": { "type": "string", "enum": [ "dynamic-group", "ruleset", "condition", "condition-identity", "condition-request", "condition-ip" ] } }, { "in": "query", "name": "filter[id]", "description": "Building Block ID Filter", "schema": { "type": "string" } }, { "in": "query", "name": "filter[id][in]", "description": "Filter for multiple Building Block IDs. *Required if `filter[id]` is not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "filter[name]", "description": "Building Block Name Filter", "schema": { "type": "string" } }, { "in": "query", "name": "filter[templateId]", "description": "Building Block Template ID Filter", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "successful operation", "headers": { "x-request-id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteResponse" }, "examples": { "Successful Delete": { "value": { "data": { "dynamicGroupCounter": "0", "ruleSetCounter": "0", "conditionCounter": "1" } } } } } } }, "400": { "description": "bad request", "headers": { "x-request-id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Identity WS not found": { "value": { "errors": [ { "code": "PAC-005", "args": { "0": "67c1ffe0-a540-4662-b894-0813abcc04ec" }, "id": "ERHCQC", "status": "400", "name": "IdentityWsNotFound", "message": "IdentityWs: [67c1ffe0-a540-4662-b894-0813abcc04ec] not found" } ] } } } } } }, "401": { "description": "Unauthorized", "headers": { "x-request-id": { "schema": { "type": "string" } } } }, "404": { "description": "not found", "headers": { "x-request-id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Building Blocks not found": { "value": { "errors": [ { "code": "PAC-005", "args": { "0": "67c1ffe0-a540-4662-b894-0813abcc04ec" }, "id": "ERHCQC", "status": "404", "name": "BuildingBlocksNotFound", "message": "Building Blocks not found" } ] } } } } } }, "422": { "description": "Validation Failed - Invalid UUID", "headers": { "x-request-id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Invalid ID Format": { "value": { "errors": [ { "code": "V-032", "args": { "0": "ed252aa5-9d0c-4193-838-60bf20b13109", "1": "uuid" }, "id": "EEJQMA", "status": "422", "name": "UnprocessableEntityError", "message": "$: test is an invalid uuid" } ] } } } } } } } } } }, "components": { "schemas": { "deleteResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dynamicGroupCounter": { "type": "integer", "description": "Number of Dynamic Groups deleted" }, "ruleSetCounter": { "type": "integer", "description": "Number of Rulesets deleted" }, "conditionCounter": { "type": "integer", "description": "Number of Conditions deleted" } } } } }, "Errors": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "Error": { "type": "object", "properties": { "code": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "integer" }, "name": { "type": "string" }, "message": { "type": "string" }, "args": { "type": "object", "properties": { "path": { "type": "string" } } } } } } } } ````