Modifying Gateway Details

CentraSite User's Guide : Runtime Governance : Gateway Management : Managing Gateways through CentraSite Business UI : Modifying Gateway Details

To modify the information of a gateway, you must have the following roles:

CentraSite Administrator: to modify the details of API Portal, Mediator, or Insight gateways within any organization.

Organization Administrator: to modify the details of API Portal, Mediator, or Insight gateways within a specific organization.

API Portal Administrator role to modify the details of API Portal gateways.

Mediator Administrator role to modify the details of Mediator gateways.

In addition to the above, you can modify the existing information of API Portal, Mediator, or Insight gateway if you have the instance level Full or Modify permission on the particular gateway.

You modify the existing information of API Portal, Mediator, or Insight gateway using the Edit action in the Gateway Details page.

Note:

If you do not see the Edit action, it is probably because you do not have the required role or permission to modify the details of the gateway.

When you modify the details of a gateway, keep the following points in mind:

CentraSite does not allow you to directly modify the endpoint URL, and tenant user information of API Portal gateway, for example, if you have an API or access token associated to the CentraSite. If you still continue to modify the information, CentraSite issues a warning message.

Some attributes accept only specific types of information. For example, for a URL type attribute, you must supply a URL when you edit that attribute.

Some attributes are designed to be read-only and cannot be edited even if they appear in a gateway on which you have Modify or Full permission.

To examine or modify the details of a gateway

1. In the CentraSite Business UI activity bar, click Manage Governance Rules.

2. To filter the list of the available API Portal, Mediator, or Insight gateways, do the following:

a. Go to the advanced search panel.

b. In the Narrow Your Results section, do the following:

a. Locate Applicable Scopes.

b. Choose API Portal, Mediator, or Insight from the drop-down list.

c. Click the plus button next to the drop-down box or press Enter to add the scope API Portal, Mediator, or Insight to the search recipe.

CentraSite displays the list of API Portal, Mediator, or Insight gateways that are available to you.

3. In the displayed list, select the gateway whose details you want to examine or modify.

This opens the Gateway Details page. The details include:

The gateway asset's basic information. This includes the gateway's asset type, the last modified date, the owning organization, and the user. In addition to the above information, an API Portal gateway asset includes the home page URL of webMethods API Portal, and the name of the onboarding organization for API Portal users in CentraSite.

The CentraSite communication information, which shows an endpoint URL of CentraSite, and the username of a CentraSite user.

The API Portal communication information, which shows an endpoint URL of API Portal gateway, and the username of a technical user in API Portal.

The Mediator communication information, which shows an endpoint URL of Mediator gateway, and the username of a user who is part of the MyMediatorGateway Synchronization Group.

The API assets published to the gateway.

Also, the actions bar displays a set of actions that are available for working with the displayed gateway.

4. On the actions bar of the Gateway Details page, click Edit.

5. In the Basic Information profile, examine or modify the properties of the displayed data fields, as required.

Field

Description

Name

The name of the gateway.

Organization

The organization to which the gateway belongs.

Onboarding Consumer Organization

For API Portal gateway only. The organization to register users of the gateway.

Note:

You are not allowed to modify the value of this field if there is at least one API Portal user onboarded in this organization.

Owner

The user who owns the gateway.

Description

Additional comments or descriptive information about the gateway.

6. For API Portal and Mediator gateways only. In the CentraSite Communication profile, examine or modify the properties of the displayed data fields, as required.

Field	Description
Endpoint	The endpoint URL of CentraSite.
Username	The user ID of the CentraSite user who has one of the following appropriate roles: API Portal Administrator Mediator Administrator Insight Administrator
Password	The password of the CentraSite user specified in the above Username field.

7. For API Portal and Mediator gateways only. In the API Portal / Mediator Communication profile, examine or modify the properties of the displayed data fields, as required.

Field

Description

Endpoint

Read-only. The endpoint URL of API Portal or Mediator gateway.

Tenant

For API Portal gateways only. The name of the tenant user in API Portal gateway.

Important:

You cannot change the value of the Tenant property if there is an API already published to the API Portal.

Use CentraSite Credentials

Enables the usage of CentraSite credentials for authenticating against API Portal or Mediator gateway.

Username

The user ID of the API Portal or Mediator user who have an API Runtime Provider role in CentraSite.

Password

The password of the user specified in the above Username field.

Sandbox

The sandbox category of the API Portal or Mediator gateway.

8. In the Published APIs profile, examine or modify the properties of the displayed data fields, as required.

Attribute	Description
Name	A deep link to the URL of the API asst details page in CentraSite.
Description	A descriptive information of the asset.
Version	The user-assigned version identifier for the asset.
View in API Portal	For API Portal gateways only. A link to the asset details page in API Portal.

9. Click Save to save the updated gateway.

If you have made changes to the CentraSite communication information, such as the CentraSite Username or Password field, make sure to publish the API Portal gateway.

Contact Support | Community | Feedback