Viewing or Modifying Details of an API-Portal Gateway

CentraSite Documentation : Working with the CentraSite Business UI : Managing Governance Rules : Using CentraSite with webMethods API-Portal : Viewing or Modifying Details of an API-Portal Gateway

You use the Edit action in the details page of an API-Portal gateway to examine and/or edit its properties.

Note:

If you do not see the Edit icon, it is probably because you not have the required role to modify the details of API-Portal.

When you modify the details of an API-Portal, keep the following points in mind:

To modify an API-Portal gateway, you must have instance-level Modify permission on the specific gateway.

If your user account belongs to API-Portal Administrator organization-level role, you automatically have permission to modify all of the API-Portal gateways in that organization.

If your user account belongs to the CentraSite Administrator role, you have permission to modify any API-Portal gateway in the CentraSite registry.

CentraSite will 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. However, If you still want to modify the information, a warning message will be issued.

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 an API-Portal gateway on which you have Modify permission.

To view or modify the details of an API-Portal gateway, proceed as follows:

To view or modify the properties of an API-Portal gateway

1. Display the list of API-Portal gateways that are available to you. If you need procedures for this step, see Displaying a List of Available API-Portal Gateways.

2. In the displayed list, click the link of the API-Portal gateway whose details you want to view or modify. This shows the details of the API-Portal.

The details include:

The API-Portal's basic information (asset type, the last modified date, owning organization, owning user, the home page URL of webMethods API-Portal, and the name of the organization for onboarding 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 APIs published to the API-Portal gateway.

3. If you want to modify the details of an API-Portal gateway, click the Edit icon. You can then enter new values for the API-Portal's fields.

4. In the Basic Information profile, examine or modify the following properties as necessary:

In this field...

Do the following...

Name

The name of the API-Portal gateway.

Organization

The organization to which the API-Portal gateway belongs.

Onboarding Consumer Organization

The organization to register users of the API-Portal 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 API-Portal gateway.

Description

Additional comments or descriptive information about the API-Portal gateway.

5. In the CentraSite Communication profile, examine, or modify the properties as necessary.

In this field...	Do the following...
Endpoint	The endpoint URL of CentraSite.
Username	The user ID of the CentraSite user who have a CentraSite Administrator or API-Portal Administrator role in CentraSite.
Password	The password of the CentraSite user specified in the above Username field.

6. In the API-Portal Communication profile, examine, or modify the properties as necessary.

In this field...

Do the following...

Endpoint

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

Tenant

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 gateway.

Username

The user ID of the API-Portal 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 gateway.

7. In the Published APIs profile, examine or modify the properties as necessary.

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

8. If you edited the settings on the details page of API-Portal gateway, click the Save icon to save the changes.

If you have made changes to the CentraSite communication information, such as the CentraSite Username or Password field, make sure you re-register (publish) the API-Portal gateway using the Publish action in the Search Results page.

Contact Support | Community | Feedback