Skip to main content

Manage API Roles

Manage API Roles—Edit (Change) API Roles—DELETE API Roles from a Specific API

You can remove API Roles from a specific individual API. Other APIs are not affected.


Remove an API Role from an API, by performing the following steps:

  • Delete it from the list of Roles for that API
  • Update the list of API Roles—without this step the Role does not get removed from the API itself


Warning: For an API in service, removing/deleting API Roles to the API can cause disruption to existing services using that API.



Figure 58. The Secure Module Main Page—Manage API Roles Page Showing Search Results for a Specific API

Figure 58. The Secure Module Main Page—Manage API Roles Page Showing Search Results for a Specific API



Click anywhere in the box of the API to open the Edit Role window for this API (Figure 58).

The Edit Role window opens (as shown in Figure 59).




Figure 59. The Secure Module Main Page—Manage API Roles Page—Specific API Edit Roles Window—Click on Name of Role to Remove It

Figure 59. The Secure Module Main Page—Manage API Roles Page—Specific API Edit Roles Window—Click on Name of Role to Remove It



Figure 59 shows the Role named “average user” being removed from this API.

Observe the Update button is not selectable at this time.

Click on the name of API Role in the list (as shown in Figure 59).


The API Role name immediately disappears (as shown in Figure 60).


The Update button is now selectable.

The Role is now removed from the list, but is not yet removed from the API itself. The removal is pending.

If you leave the page, the Role adds back to the list and you would need to start again.


Clicking on Cancel also causes the Role to be back on the list.




Figure 60. The Secure Module Main Page—Manage API Roles Page—Specific API Edit Roles Window—Name Removed from List but Not Yet from the API

Figure 60. The Secure Module Main Page—Manage API Roles Page—Specific API Edit Roles Window—Name Removed from List but Not Yet from the API




Click on the Update button to remove that Role from the API.


The confirmation window opens (as shown in Figure 61).




Figure 61. The Secure Module Main Page—Manage API Roles Page—Specific API Edit Roles Window—Edit Confirmation Window

Figure 61. The Secure Module Main Page—Manage API Roles Page—Specific API Edit Roles Window—Edit Confirmation Window




Warning: For an API in service, removing/deleting API Roles from the API can cause disruption to existing services using that API.



Click on the Yes button.


The Confirmation window closes.


The Role is removed from this specific API itself and from list of Roles for this specific API (as shown in Figure 62).

When you have successfully removed the API Role from the API, a confirmation Success banner message with a green check mark in the upper right of page appears BRIEFLY (a couple of seconds) as shown in Figure 62.




Figure 62. The Secure Module Main Page—Manage API Roles Page—Successful Removal of API Roles from a Specific API

Figure 62. The Secure Module Main Page—Manage API Roles Page—Successful Removal of API Roles from a Specific API