Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. In Manager, click the shared folder for your Org (also known as the global shared folder), then click Manage API Policy to view the API Policy Manager -shared dialog window, which displays a list of existing API policies and their status.

    Manage API PolicyImage RemovedImage Added

  2. In the API Policy Manager -shared dialog window, click Add Policy to view a list of policies.

    Image RemovedImage Added
  3. Select a policy from the list of policies to open the settings dialog window.

  4. Enter/modify the fields to configure the policy as required, then click Validate and Save.

    The policy settings dialog window closes, and your policy is displayed in the API Policy Manager-shared dialog window.

    Image RemovedImage Added

You can also import and export policies in the API Policy Manager-shared dialog window.

...

  1. In the SnapLogic Manager navigation pane under API Management, click API Manager

    Open API Manager

    The API Manager page opens.

    Image RemovedImage Added
  2. Click the target API to open the API Details page, and click (blue star) to open display the list of API policies.

    Image RemovedImage Added
  3. Enter or modify the fields as required to configure the policy.

  4. Click Validate and Save.

    The policy settings dialog window closes, and your policy is displayed on the API Details page.

    Image RemovedImage Added

Adding API Policies to API Versions
Anchor
api-version-level
api-version-level

  1. In the SnapLogic Manager navigation pane under API Management, click API Manager

    Open API ManagerImage RemovedOpen API ManagerImage Added

    The API Manager page opens.

    Image RemovedImage Added
  2. Click the target API to view the API Details page.

  3. In the API Details page, click the Versions tab, then click the target API version to view the Version Details page.

  4. In the Version Details page, click the target to view the API Details page, and click (blue star)  to open display the list of API policies.

    Image Added
  5. Enter or modify the fields as required to configure the policy.

  6. Click Validate and Save.

    The policy settings dialog window closes, and your policy is displayed in the API Details page.

    Image RemovedImage Added

Adding API Policies to Projects and Project Space Shared Folders in Manager
Anchor
projects-projspaces-level
projects-projspaces-level

...

  1. In Manager, select the target Project Space/Project, click (blue star) to open the dropdown list, and select Manage API Policy to open the API Policy Manager dialog window.

  2. Click Add Policy. A list of all the API policy types appears. 

    Image RemovedImage Added
  3. Click the API policy that you want to add. The settings dialog window for that policy is displayed. 

    Image RemovedImage Added
  4. Enter/modify the field values to configure the policy, then click Validate & Save. The API policy is added to the list of API policies. 

  5. Click Close to close the API Policy Manager dialog.

...

  1. Open the API Policy Manager dialog. 

  2. Click the target API policy to open its settings.

  3. Change the value of the Status field. 

  4. Click Validate & Save. You can confirm the Status of the API policy is updated.
    To enable the API policy, repeat steps 2 through 4. 

    Image RemovedImage Added

Note

Adding the same API policy type at a lower-level in the hierarchy automatically overrides all API policies of the same type at higher levels. For example, if a Callout Authenticator API policy is added at an Org-level and also at the Project-space-level, the Org-level is automatically overridden as far as the Tasks within that Project Space are concerned.

...

  1. In Manager, navigate to the target task.

  2. Point the cursor at the target task and click (blue star)  to open the dropdown then , and select Related API Policy.

    Image RemovedImage Added

    The Related Policies dialog window for the target Task is displayed.

    Image RemovedImage Added
  3. Click the Hierarchy tab to open the policy hierarchy.

    Image RemovedImage Added

Editing Policies in Manager

...

  1. Depending on the asset associated with the API policy, choose one of the following methods to view the settings dialog window for an API policy.

    • For an Org:

      • Navigate to the Org-level shared folder in Manager, and place the cursor over the target Project Space/Project,

      • Click  (blue star)  to view the dropdown list and select Manage API Policy

    • For a Project Space or Project,

      1. Navigate to the target asset in Manager, and place the cursor over the target Project Space/Project,

      2. Click  (blue star)  to view the dropdown list and select Manage API Policy.  

    • For the API Management space, click the target API policy at one of the following levels:

      • Org-level shared folder.

      • API Details page

      • Version Details page
         

  2. Edit/update the API policy and click Validate & Save.

...

  1. Navigate to the destination API Asset in API Manager.

  2. Click (blue star) to open the Import Policy dialog.

  3. Select Choose File and go to the policy file on your machine.

  4. Select an import option.

    • Import non-existent only: (Default) Only uploads the API policies in the selected file that do not already exist in the target API, API Version, or Proxy.

    • Import all policies: Imports all API policies in the selected file:

    Image RemovedImage Added
  5. Click Import. The Import Policy Result popup appears with the following options:

    • Added: The API policies added to the Project Folder.

    • Overwritten: The existing API policies overwritten by the imported ones.

    • Ignored: The existing API policies not overwritten by the imported ones.

...

  1. Navigate to the target Project or shared folder in the Project Space in SnapLogic Manager.

  2. Right-click to open the dropdown list, and click Manage API Policy. The API Policy Manager dialog appears.

  3. Select Choose File and navigate to the target file.

    • Import non-existent only: (Default) Only uploads API policies in the selected file that do not already exist in the Project or shared folder.

    • Import all policies: Imports all API policies in the selected file.

    Image RemovedImage Added
  4. Click Import. The Import Policy Result popup appears with the following Status:

    • Added: The API policies added to the Project Folder.

    • Overwritten: The existing API policies overwritten by the imported ones.

    • Ignored: The existing API policies not overwritten by the imported ones.

...