Assigning organizations to a domain

Assign a domain to one or more organizations from the Organizations tab (Manage > Domains > your domain name > Organizations).

Procedure

1. Click API Program Domains on the Get Started page or navigate to Manage > Domains. This opens the View and manage domains for APIs page.

2. In the Domain Suffix column, click the domain link or Settings icon next to the domain you want to assign to one or more organizations. This opens the Domain Settings page.

3. Navigate to Organizations. By default, Area Wide (All Organizations) is selected. All approved allowlisted domains in Cloud API Management are available to all organizations in an area by default.

   1. Choose Area Wide (All Organizations) to keep area-wide access.

   2. Choose Assign to specific organization to restrict the domain to specific organizations.

      1. Click Add Organizations. This opens the Add Organizations dialog.

         1. Optional: In the Search box, enter text to find the organizations you want to assign.

         2. Select the checkbox next to each organization. If a selected organization has sub-organizations, the domain is automatically mapped to them as well.

         3. Click Add. The selected organizations appear in the Mapped organizations section.

            To remove an organization, click the Remove icon (x) next to the organization you want to unmap.

            note

            You cannot remove an organization mapping if any API endpoint within that organization is actively using it. To remove such a mapping, first update the resource endpoint to use a different public endpoint domain.

4. Click Save.

Adding mapped organization domain to a public endpoint

After assigning organizations to a domain, add the mapped organization to your API Definition resource endpoint so that only the mapped organization can use it. Create a resource endpoint on the Endpoints: <your api definition name> page and configure the public endpoint address on the Endpoint Create: New Endpoint Definition page to use your organization's mapped domain.

Procedure

1. Navigate to Design > APIs. This opens the Manage your APIs with API Definitions page.

2. In the Name column, click the API definition link or Settings icon for the API definition whose organization you want to update. This opens the API Definition Settings: <your api definition> page.

   1. In Select one organization or group to own this API, select the organization you mapped on the Organizations (Manage > Domains > your domain name > Organizations) page.

3. Navigate to the Endpoints tab to create a new endpoint and configure its public endpoint address.

   1. Click New Endpoint. This opens the Endpoint Create: New Endpoint Definition page.

   2. In Name for your Endpoint, enter the endpoint name.

   3. In Customize your Public Endpoint Address:

      1. In the first field, enter the domain name mapped to your organization. You can find this on the Domain Settings: <your domain name> page.

         note

         Only a domain mapped to your organization or set to Area Wide (All Organizations) can be configured with the public endpoint. If you enter a domain that is not mapped to your organization, an error message is displayed.

      2. In the second field, enter the endpoint path.

   4. Click Create.