Organization Policies

Manage policies associated with an organization on the API platform.

For general information on using policies, refer to:

API Platform Version: 8.4 and later

Table of Contents

  1. How do I manage policies for my organization?
  2. How do I add a policy for my organization?
  3. How do I edit a policy for my organization?
  4. How do I delete a policy for my organization?
  5. How do I move a policy from one organization to another?
  6. How do I activate a policy that's in Draft state?
  7. How do I add a new version of a policy that's in Active state?

How do I manage policies for my organization?

The API platform allows you to manage the policies that are available for your business organization. You can:

All the policies available for your business organization are available for all child organizations also.

Note: For general information about all policies, see About Policies (Policy Manager help).

Back to top

How do I add a policy for my organization?

There are two steps to adding a policy:

  • Define the basic information about the policy, such as name, description, and policy type: see To add a policy below.
  • Configure the policy to define what it actually does: see To configure a policy below.
To add a policy
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Click Add.
  5. In the Add Policy page, specify:
    • Policy Name: A short, descriptive name for the policy. Used on the policy summary page.
    • Policy Category: Choose from the standard list of policy types. Supported policy categories are:
    • Policy Sub-Type: When you choose a policy type, the Policy Sub-Type drop-down list appears. Choose from the standard list of sub-type for the specified policy type.
    • Policy Description: A brief description of the policy. Include any key information relating to how the policy is used and what it does.
  6. Click Save. The policy is added to the list of policies for the organization.
To configure a policy
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Find the policy on the list and click the title to access the policy details.
  5. In the Policy Summary section at the bottom, click Modify. The configuration page for the specific policy is displayed.
  6. Modify values as needed. For information about configuring a specific policy type, refer to About Policies.
  7. When done, click Save. The Modify window closes, and the Policy Summary is updated with your changes.

Back to top

How do I edit a policy for my organization?

There are two things relating to a policy that you can edit:

To edit a policy definition
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Find the policy that you want to edit, and then click the title to view the Details page for the policy.
  5. In the top section of the page for the policy, click Edit.
  6. Edit values as needed. You can edit:
    • Policy Name
    • Policy Category
    • Policy Sub-Type
    • Policy Description.
  7. Click Save.
To edit the configuration of a policy
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Find the policy that you want to edit, and then click the title to view the Details page for the policy.
  5. In the bottom section of the page for the policy, click Edit. A separate window opens with the policy configuration.
  6. Edit the policy values. Specific fields vary according to the policy type. For information about configuring a specific policy type, refer to About Policies.
  7. Save changes.

Back to top

How do I view policies that are set up for my organization?

Policies might be set up in the developer portal or in the underlying infrastructure, Policy Manager. To view the policies currently in effect for your organization, follow the steps below.

To view policies for a specific organization
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. To view details for a specific policy, find the policy on the list, and then click the title to view the Details page for the policy.
  5. To view in greater detail, click the View button in the bottom section. The policy is displayed in a separate window. Here, you can:
    • Check syntax
    • Check schema

    When done, click Cancel to close the separate window.

Back to top

How do I delete a policy for my organization?

When you delete a policy, it isn't reversible; you can add the policy again, but you will have to re-create it from scratch. You'll lose any work that went into creating the policy. Be sure you want to delete it.

You can delete a policy in the developer portal or in the underlying infrastructure. To delete from the developer portal, follow the steps below.

Note: If a policy is referenced by one or more resources, such as APIs, you cannot delete it. You must first update the policy assignment.

To delete a policy
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Find the policy that you want to delete, and then click the title to view the Details page for the policy.
  5. Click Delete.
  6. At the confirmation message, click OK. The policy is deleted.

Back to top

How do I move a policy from one organization to another?

You can move a policy that's in Draft state between business organizations as long as you are a Business Administrator for both organizations.

Note: Once a policy is in Active state, you can't move it between organizations.

To move a draft policy from one business organization to another
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Find the policy that you want to move, and then click the title to view the Details page for the policy.
  5. Click Edit.
  6. On the right, in the Parent Organization Name field, start typing the name of the organization you want to move it to. After the first three characters, the platform displays a list of matching organizations for you to choose from.
  7. Click Save. The policy is moved.

Back to top

How do I activate a policy that's in Draft state?

You can activate a policy that's in Draft state, either in the developer portal or in the underlying infrastructure, Policy Manager. To activate a draft policy in the developer portal, follow the steps below.

To activate a draft policy
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Find the policy that you want to activate, and then click the title to view the Details page for the policy.
  5. At the top right, click the down arrow to view the Additional Items menu, and then click Activate Policy, as shown below.

    Activating a draft policy

  6. In the Perform Workflow Actions pop-up, enter a brief statement about your action in the Comments field, and click OK. The policy is activated.

Back to top

How do I add a new version of a policy?

You can only add a new version of a policy if the policy is in Active state. The new version that's created is in Draft state. Follow the steps below.

To start a new version of an active policy
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Policies. All policies associated with the organization are displayed.
  4. Find the policy that you want to start a new version for, and then click the title to view the Details page for the policy.

    Note: The State value for the policy must be Active.

  5. At the top right, click the down arrow to view the Additional Items menu, and then click Start New Version, as shown below.

    Starting a new version of an existing policy

  6. At the confirmation message, click OK. A new version of the policy is created, in Draft state.

Back to top