Delete Universal Zero Trust Rule - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Delete Universal Zero Trust Rule","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Delete the Universal Zero Trust rule associated with the specified UUID. _Check the response section for applicable examples (if any)._**","operationId":"deleteUniversalZeroTrustRule","parameters":[{"description":"Unique identifier of the Universal Zero Trust rule.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : DELETE /fmc_config/v1/domain/{domainUUID}/policy/universalzerotrustpolicies/{containerUUID}/universalzerotrustrules/ ( Bulk DELETE method to remove multiple Universal Zero Trust Rules )":{"value":[{"action":"ALLOW","enabled":"true/false","filePolicy":{"id":"\u003cFilePolicyUUID_1\u003e","name":"\u003cFilePolicyName_1\u003e","type":"FilePolicy"},"id":"\u003cuniversal_zero_trust_rule_UUID_1\u003e","intrusionPolicy":{"id":"\u003cIntrusionPolicyUUID_1\u003e","name":"\u003cIntrusionPolicyName_1\u003e","type":"IntrusionPolicy"},"links":{"self":"/fmc_config/v1/domain/{domainUUID}/policy/universalzerotrustpolicies/{containerUUID}/universalzerotrustrules/{universal_zero_trust_rule_UUID_1}"},"name":"\u003cuniversal_zero_trust_rule_name_1\u003e","posture":{"id":"\u003cRandomPostureUUID_1\u003e","name":"\u003cRandomPostureName_1\u003e","type":"RandomPostureType"},"privateResources":[{"id":"\u003cPrivateResourceUUID_1\u003e","name":"\u003cPrivateResourceName_1\u003e","type":"PrivateResource"}],"ruleIsDefault":"true/false","rulePriority":0,"sseRuleId":125,"type":"UniversalZeroTrustRule","users":[{"id":"\u003cUserUUID_1\u003e","name":"\u003cUserName_1\u003e","type":"User"}]},{"action":"ALLOW","enabled":"true/false","filePolicy":{"id":"\u003cFilePolicyUUID_2\u003e","name":"\u003cFilePolicyName_2\u003e","type":"FilePolicy"},"id":"\u003cuniversal_zero_trust_rule_UUID_2\u003e","intrusionPolicy":{"id":"\u003cIntrusionPolicyUUID_2\u003e","name":"\u003cIntrusionPolicyName_2\u003e","type":"IntrusionPolicy"},"links":{"self":"/fmc_config/v1/domain/{domainUUID}/policy/universalzerotrustpolicies/{containerUUID}/universalzerotrustrules/{universal_zero_trust_rule_UUID_2}"},"name":"\u003cuniversal_zero_trust_rule_name_2\u003e","posture":{"id":"\u003cRandomPostureUUID_2\u003e","name":"\u003cRandomPostureName_2\u003e","type":"RandomPostureType"},"privateResources":[{"id":"\u003cPrivateResourceUUID_2\u003e","name":"\u003cPrivateResourceName_2\u003e","type":"PrivateResource"}],"ruleIsDefault":"true/false","rulePriority":0,"sseRuleId":126,"type":"UniversalZeroTrustRule","users":[{"id":"\u003cUserUUID_2\u003e","name":"\u003cUserName_2\u003e","type":"User"}]}]},"Example 2 : DELETE /fmc_config/v1/domain/{domainUUID}/policy/universalzerotrustpolicies/{containerUUID}/universalzerotrustrules/{universal_zero_trust_rule_UUID} ( DELETE method to remove a Universal Zero Trust Rule )":{"value":{"action":"ALLOW","enabled":"true/false","filePolicy":{"id":"\u003cFilePolicyUUID\u003e","name":"\u003cFilePolicyName\u003e","type":"FilePolicy"},"id":"\u003cuniversal_zero_trust_rule_UUID\u003e","intrusionPolicy":{"id":"\u003cIntrusionPolicyUUID\u003e","name":"\u003cIntrusionPolicyName\u003e","type":"IntrusionPolicy"},"links":{"self":"/fmc_config/v1/domain/{domainUUID}/policy/universalzerotrustpolicies/{containerUUID}/universalzerotrustrules/{universal_zero_trust_rule_UUID}"},"name":"\u003cuniversal_zero_trust_rule_name\u003e","posture":{"id":"\u003cRandomPostureUUID\u003e","name":"\u003cRandomPostureName\u003e","type":"RandomPostureType"},"privateResources":[{"id":"\u003cPrivateResourceUUID\u003e","name":"\u003cPrivateResourceName\u003e","type":"PrivateResource"}],"ruleIsDefault":"true/false","rulePriority":0,"sseRuleId":125,"type":"UniversalZeroTrustRule","users":[{"id":"\u003cUserUUID\u003e","name":"\u003cUserName\u003e","type":"User"}]}}},"schema":{"type":"object","properties":{"action":{"enum":["BLOCK","ALLOW"],"type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean"},"filePolicy":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"id":{"type":"string"},"intrusionPolicy":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"posture":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"privateResources":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"ruleIndex":{"format":"int32","type":"integer"},"ruleIsDefault":{"type":"boolean"},"rulePriority":{"format":"int32","type":"integer"},"sseRuleId":{"format":"int32","type":"integer"},"sseRuleName":{"type":"string"},"type":{"type":"string"},"users":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"version":{"type":"string"}},"required":["action"],"$$ref":"#/components/schemas/UniversalZeroTrustRule"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Policy"],"__originalOperationId":"deleteUniversalZeroTrustRule","method":"delete","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/universalzerotrustpolicies/{containerUUID}/universalzerotrustrules/{objectId}"}}