Skip to main content

Manage Service Principals—Assign API Roles—Remove Role

Manage Service Principals—Assign API Roles—Remove Role

Remove a Role assigned to a specific API.



Figure 104.  The Secure Module Main Page—Manage API Roles Page—Select Manage Service Principals

Figure 104. The Secure Module Main Page—Manage API Roles Page—Select Manage Service Principals




On the Secure Module Main Page which is the Manage API Roles page, click on the Left Navigation Secure Module sub-menu—Principals icon (as shown in Figure 104).

The Secure Module—Manage Service Principals page opens (as shown in Figure 105).




Figure 105. The Secure Module—Manage Service Principals Page

Figure 105. The Secure Module—Manage Service Principals Page




If needed, use the Search or Filter feature at the top of the page to enter part of the name or Client ID number of the API from which you want to REMOVE (Delete) an API Role.




Figure 106. The Secure Module—Manage Service Principals Page—Pop-up Message Showing Current API Role as “User”

Figure 106. The Secure Module—Manage Service Principals Page—Pop-up Message Showing Current API Role as “User”




On the specific API, mouseover or hover over Api Roles and the pop-up message appears stating the Role in this example is currently “user,” and has a blue link to “Assign Api Roles” (as shown in Figure 106).

In this example, we are removing (deleting) the User’s Role of “user” and not replacing it with any other Role.


Click on the link Assign Api Roles.

The Assign Api Roles window opens (as shown in Figure 107).




Figure 107. The Secure Module—Manage Service Principals Page—Assign Api Roles Window

Figure 107. The Secure Module—Manage Service Principals Page—Assign Api Roles Window




Your organization’s list of APIs may be long and you may need to use the elevator for the window (Figure 107 middle arrow).

When you find the API (in the example in Figure 107, “Gabrielle’s API”), click on the Role for this API (in the example in Figure 107 top arrow pointing to “user”).

The following responses occur:

  • The Role is now removed (or deleted)
  • The Save button becomes selectable (as shown in Figure 108)



Figure 108. The Secure Module—Manage Service Principals Page—Assign Api Roles Window—Selection of API Role

Figure 108. The Secure Module—Manage Service Principals Page—Assign Api Roles Window—Selection of API Role




Click on the Save button.

The Assign Api Roles window closes.




Figure 109. The Secure Module—Manage Service Principals Page—Successful Removal of API Role for a Specific API

Figure 109. The Secure Module—Manage Service Principals Page—Successful Removal of API Role for a Specific API




When you have successfully deleted the Client Secret or Credential, 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 109.




Figure 110. The Secure Module—Manage Service Principals Page—Pop-up Message Showing API Role as No Role Set Yet

Figure 110. The Secure Module—Manage Service Principals Page—Pop-up Message Showing API Role as No Role Set Yet




On the specific API, mouseover or hover over Api Roles and the pop-up message appears stating the API Role has No Roles Set Yet (as shown in Figure 110).