Documentation update: delete division resource

Announcements
1

Description

The documentation for the DELETE /api/v2/authorization/divisions/{divisionId} endpoint will be updated to indicate that customers should take caution when deleting a division and when using the force query parameter.

Change Category

API

Change Context

This change is to draw awareness to:

  1. The force query parameter, so that customers do not utilize the parameter without understanding its impact. Customers should understand that using the force parameter will irrevocably delete any objects associated with the division to be deleted (as well as any role grants to the division to be deleted.)
  2. The impact of calling the DELETE endpoint. Customers should understand that calling this endpoint will cause any objects associated with the division to be permanently inaccessible. We advise that customers ensure there are no objects in the division before makeing the DELETE call.

Change Impact

There is no material impact; only the documentation will change.

Date of Change

Immediate

Impacted APIs

DELETE /api/v2/authorization/divisions/{divisionId}

References

[PURE-5813]