Manage Service Principals—Assign API Roles

Manage Service Principals—Assign API Roles—Intro, Add Roles

Each User can have 1 Role assigned for each API. A User cannot have more than 1 Role per API.

If your organization has 100 APIs in PortX Integration Manager then each User could have a maximum of 1 Role for each API, in this example for a maximum of 100 Roles.

Each User might not have any Role assigned for many or most APIs. For example, if your organization has 100 APIs then your organization may choose that most of your Users might only have 1 Role for 1 API.

ADD a Role to an API

Add or assign an existing Role to a specific API.

Figure 89. 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 89).

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

Figure 90. 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 to which you want to ADD an API Role.

Figure 91. The Secure Module—Manage Service Principals Page—Pop-up Message Showing Current API Role if Any

On the specific API, mouseover or hover over Api Roles and the pop-up message appears stating the Role currently set, if any, and a blue link to “Assign Api Roles” (as shown in Figure 91).

Click on the link Assign Api Roles.

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

Figure 92. 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 92 lower arrow).

When you find the API (in the example in Figure 92 “Gabrielle’s API”), click on the Chevron (Figure 92 upper arrow) and the line expands to show the User Roles for this API (as shown in Figure 93).

Figure 93. The Secure Module—Manage Service Principals Page—Assign Api Roles Window—Choice of API Roles

After you select a Role, then the Save button becomes selectable (in Figure 93 the Save button is not selectable).

Click on the radio button for a Role (in this example the Role of “user” is selected as shown in Figure 94 middle arrow).

The following responses occur:

• The Role is listed next to the name of the API (as shown in Figure 94 top arrow)
• The Save button becomes selectable (as shown in Figure 94 bottom arrow)

Figure 94. 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.

When you have successfully saved the new API Role, 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 95.

Figure 95. The Secure Module—Manage Service Principals Page—Successful Addition of API Roles to a Specific API

On the specific API, mouseover or hover over Api Roles and the pop-up message appears stating the Role currently set is “user” (as shown in Figure 96).

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

---