Modifying and deleting security zones

Modifying security zones

Use the following endpoints to modify a security zone:

  • PATCH /admin/v1/security-zones/{securityZoneId}

For example, the following request modifies security zone xc:111.

PATCH /admin/v1/security-zones/xc:111

{
  "data": {
    "attributes": {
        "description": "Security zone created using Cloud API"
    }
  }
}

Note that there are differences between security zone functionality in the base configuration of the different applications.

  • In ClaimCenter and BillingCenter, users can edit security zones. This is done from the Admin tab's Security Zones screen in the Users & Security group.
  • In PolicyCenter, users cannot edit security zones.

Deleting security zones

In ClaimCenter, use the following endpoints to delete a security zone:

  • DELETE /admin/v1/security-zones/{securityZoneId}

For example, in ClaimCenter, the following request deletes security zone xc:111.

DELETE /admin/v1/security-zones/xc:111

<no request body>

In PolicyCenter and BillingCenter, users cannot delete security zones, either through the user interface or through Cloud API. The DELETE /security-zones/{securityZoneId} endpoint is exposed in Cloud API for PolicyCenter and Cloud API for BillingCenter. But if you attempt to use it, Cloud API returns the following error. This is true even for the super user "su", who is not bound by permissions.

{
    "status": 403,
    "errorCode": "gw.api.rest.exceptions.NotAuthorizedException",
    "userMessage": "You do not have permission to delete this resource"
}