Documentation
 

Search Results

Organization API Definitions

The Organization API Definitions page displays a list of API Definitions for a specific Organization and its Sub-Organizations, if any. You have to specify the Organization name while creating the API Definition. To add an Organization name to an API Definition, see Creating an API.
Note: This page can be accessed by the Organization Administrator and the API Manager.
The Organization Administrator can:
  • View and modify the API Definitions.
  • Change the Organization ownership of the API Definitions on the API Definition Settings page.

On the Organization API Definitions page, the Organization Administrator can set the Control Center visibility of the APIs. The API Definitions in the Organization are made visible (read-only) to other Organizations. Hence, the users in the other Organizations can view the API Definitions for various business requirements. To know more about API Definitions, see API Definitions and API Definition & Endpoint List.

To add an API Definition to an Organization, see Creating an API.

To view the API Definitions page:

  1. Click Manage > Organizations.

    The Organizations page displays a list of Organizations.

  2. Select an Organization in the Organization list.

    The Organization Overview page is displayed.

  3. On the left pane, click API Definitions.

    The Organization API Definitions page is displayed.

The following table describes the fields on the Organization API Definitions page.
Field Description

API Definition Name

Name of the API Definition owned by the Organization.

Control Center visibility

The Organization names for which the API definitions are visible.

The API Definitions in the Organization are made visible (read-only) to other Organizations. Hence, the users in the other Organizations can view the API Definitions for various business requirements. You can add multiple Organizations.
Note: The API Definition can be modified only by the Administrator or API Manager of the Organization that owns the API. All other Organizations users (including the API Manager and the Administrator) in the Control Center visibility have read-only access to that API definition.

To add Organizations to the Control Center visibility list see Control Center visibility.

Organization

The Organization to which the API Definition belongs.

Actions

Click > to navigate to the Access Settings page where you can assign roles to the users.

Click the settings icon to navigate to the API Definition Edit page.