Add IAM conditions

This page applies to Apigee and Apigee hybrid.

Identity and Access Management (IAM) Conditions lets you to define and enforce conditional access control for Google Cloud resources, including API hub resources. For more information about IAM Conditions, see Overview of IAM Conditions.

In API hub, you can enforce conditional access based on the following IAM resource condition attributes:

  • resource.service condition attribute: Use to configure conditional access based on the Google Cloud service being used. For example, you can set a condition limiting a user's access to resources that use the apihub.googleapis.com. For a list of supported values, see Resource service values.
  • resource.type condition attribute: Use to configure conditional access based on the type of resource being accessed. For example, you can set a condition limiting a user's access to apihub.googleapis.com/Api. For a list of supported values, see Resource type values.
  • resource.name condition attribute: Use to configure conditional access based on all or part of the name of a resource. For a list of supported API hub name formats, see Resource name format.

Add IAM condition

To add an IAM condition to a existing principal (user, group, or service account), perform the following steps:

  1. In the Google Cloud console, go to the IAM page.

    Go to IAM

  2. Select your project, folder, or organization.
  3. From the list of principals, find the principal for which you want to add the IAM condition, and click (Edit principal).

    The Edit access pane appears.

  4. Find the role to which you want to add the IAM condition and click + Add IAM Condition.
  5. In the Add condition pane, provide the following information:
    1. Title: Enter a name for the condition that you're adding to the role.
    2. Description: (Optional) Enter a description for the condition.
    3. You can add a condition using either the Condition builder or the Condition editor.

      The Condition builder provides an interactive interface to select your desired condition type, operator, and other applicable details about the expression. The Condition editor provides a text-based interface to manually enter a condition expression using CEL syntax.

      For detailed instructions about how to use the Condition builder or the Condition editor, see Configure resource-based access.

    4. Click Save to apply the condition.
  6. Click Save again from the Edit access pane to update the principal.

Examples of using IAM conditions for API hub

Example 1: Access control for all API resources starting with IAM condition based on resource name.

The following condition expression defines access control as follows:

  • Access to API resources starting with prefix. This includes access to all API resources, including API versions, deployments, specifications, operations, and definitions.
  • Default role-based non-conditional access to other API hub resources.
  (
    resource.name.startsWith("projects/PROJECT_ID/locations/LOCATION/apis/API_ID_PREFIX") ||
    (
      resource.type != "apihub.googleapis.com/Api" &&
      resource.type != "apihub.googleapis.com/Version" &&
      resource.type != "apihub.googleapis.com/Spec" &&
      resource.type != "apihub.googleapis.com/ApiOperation" &&
      resource.type != "apihub.googleapis.com/Definition"
    )
  )

Replace the following:

  • PROJECT_ID: The ID of your Google Cloud project.
  • LOCATION: The API hub location.
  • API_ID_PREFIX: The prefix for the API resource name.

Example 2: Access control for multiple APIs with IAM conditions based on resource type.

The following condition expression defines access control as follows:

  • Access to the API hub API resources starting with prefix.
  • Access to the API hub version resource starting with a specified version ID.
  • Access to the API hub spec resources starting with a specified spec ID.
  • Default role-based non-conditional access to other API hub resources.
  (
    resource.service == "apihub.googleapis.com" &&
    resource.type == "apihub.googleapis.com/Api" &&
    resource.name.startsWith("projects/PROJECT_ID/locations/LOCATION/apis/API1_ID_PREFIX")
  ) ||
  (
    resource.service == "apihub.googleapis.com" &&
    resource.type == "apihub.googleapis.com/Version" &&
    resource.name == "projects/PROJECT_ID/locations/LOCATION/apis/API2_ID/versions/API2_VERSION_ID"
  ) ||
  (
    resource.service == "apihub.googleapis.com" &&
    resource.type == "apihub.googleapis.com/Spec" &&
    resource.name == "projects/PROJECT_ID/locations/LOCATION/apis/API3_ID/versions/API3_VERSION_ID/specs/API3_SPEC_ID"
  ) ||
  (
    resource.type != "apihub.googleapis.com/Api" &&
    resource.type != "apihub.googleapis.com/Version" &&
    resource.type != "apihub.googleapis.com/Spec" &&
    resource.type != "apihub.googleapis.com/ApiOperation" &&
    resource.type != "apihub.googleapis.com/Definition"
  )
 Replace the following:

  • PROJECT_ID: The ID of your Google Cloud project.
  • LOCATION: The API hub location.
  • API1_ID_PREFIX: The prefix for the first API resource name.
  • API2_ID: The ID of the second API resource.
  • API2_VERSION_ID: The ID of the second API version resource.
  • API3_ID: The ID of the third API resource.
  • API3_VERSION_ID: The ID of the third API version resource.
  • API3_SPEC_ID: The ID of the third API spec resource.