Delete Rule
DELETE {{apiPath}}/environments/{{envID}}/propagation/rules/{{ruleID}}
The following sample shows the DELETE /environments/{{envID}}/propagation/rules/{{ruleID}}
operation to delete the propagation rule resource specified by its ID in the request URL.
Parameter | Description |
---|---|
deprovision | When equal to true , enables deprovisioning of users when rules and associated stores are deleted. |
Example: DELETE /environments/{{envID}}/propagation/rules/{{ruleID}}?deprovision=true
Note: To successfully use the deprovision
query parameter, either:
- The managed
property (preferred) must also be set to true
on the target store using either POST {{apiPath}}/environments/{{envID}}/propagation/stores
or PUT {{apiPath}}/environments/{{envID}}/propagation/stores/{{storeID}}
.
- The deprovision
property (deprecated but if used) must also be set to true
on the rule using either POST {{apiPath}}/environments/{{envID}}/propagation/rules
or PUT {{apiPath}}/environments/{{envID}}/propagation/rules/{{ruleID}}
.
When successful, the DELETE
request returns an empty response with a status code 204 No Content
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
deprovision | boolean | When equal to true, enables deprovisioning of users when rules and associated stores are deleted. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |