Manage GCP API Gateway IAM Policies

The gcp:apigateway/apiConfigIamPolicy:ApiConfigIamPolicy resource, part of the Pulumi GCP provider, manages IAM permissions for API Gateway API configurations. This guide focuses on three approaches: authoritative policy replacement, role-level member management, and incremental member addition.

These resources reference an existing API Gateway API and ApiConfig. ApiConfigIamPolicy replaces the entire policy, ApiConfigIamBinding manages all members for a specific role, and ApiConfigIamMember adds individual members without affecting others. The examples are intentionally small. Choose the resource type that matches your update strategy.

Replace the entire IAM policy for an API config

When you need complete control over access, you can set the entire IAM policy at once.

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/apigateway.viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.apigateway.ApiConfigIamPolicy("policy", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    policyData: admin.then(admin => admin.policyData),
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/apigateway.viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.apigateway.ApiConfigIamPolicy("policy",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    policy_data=admin.policy_data)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigateway"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/apigateway.viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.NewApiConfigIamPolicy(ctx, "policy", &apigateway.ApiConfigIamPolicyArgs{
			Api:        pulumi.Any(apiCfg.Api),
			ApiConfig:  pulumi.Any(apiCfg.ApiConfigId),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/apigateway.viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.ApiGateway.ApiConfigIamPolicy("policy", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.apigateway.ApiConfigIamPolicy;
import com.pulumi.gcp.apigateway.ApiConfigIamPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/apigateway.viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new ApiConfigIamPolicy("policy", ApiConfigIamPolicyArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .policyData(admin.policyData())
            .build());

    }
}

resources:
  policy:
    type: gcp:apigateway:ApiConfigIamPolicy
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      function: gcp:organizations:getIAMPolicy
      arguments:
        bindings:
          - role: roles/apigateway.viewer
            members:
              - user:jane@example.com

ApiConfigIamPolicy is authoritative: it replaces all existing IAM bindings on the API config. The policyData comes from getIAMPolicy, which defines roles and members in a structured format. Use this when you want to define the complete access policy from scratch, but be aware it removes any bindings not included in the policy data.

Grant a role to multiple members at once

Teams often assign the same role to several users without replacing other role assignments.

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.apigateway.ApiConfigIamBinding("binding", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    role: "roles/apigateway.viewer",
    members: ["user:jane@example.com"],
});

import pulumi
import pulumi_gcp as gcp

binding = gcp.apigateway.ApiConfigIamBinding("binding",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    role="roles/apigateway.viewer",
    members=["user:jane@example.com"])

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiConfigIamBinding(ctx, "binding", &apigateway.ApiConfigIamBindingArgs{
			Api:       pulumi.Any(apiCfg.Api),
			ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
			Role:      pulumi.String("roles/apigateway.viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.ApiGateway.ApiConfigIamBinding("binding", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        Role = "roles/apigateway.viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiConfigIamBinding;
import com.pulumi.gcp.apigateway.ApiConfigIamBindingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var binding = new ApiConfigIamBinding("binding", ApiConfigIamBindingArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .role("roles/apigateway.viewer")
            .members("user:jane@example.com")
            .build());

    }
}

resources:
  binding:
    type: gcp:apigateway:ApiConfigIamBinding
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      role: roles/apigateway.viewer
      members:
        - user:jane@example.com

ApiConfigIamBinding is authoritative for a single role: it sets the complete member list for that role while preserving other roles. The members array can include users, service accounts, and groups. If another binding exists for the same role, this resource replaces it.

Add a single member to a role incrementally

When you need to grant access to one user without affecting existing members, use the non-authoritative approach.

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.apigateway.ApiConfigIamMember("member", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    role: "roles/apigateway.viewer",
    member: "user:jane@example.com",
});

import pulumi
import pulumi_gcp as gcp

member = gcp.apigateway.ApiConfigIamMember("member",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    role="roles/apigateway.viewer",
    member="user:jane@example.com")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiConfigIamMember(ctx, "member", &apigateway.ApiConfigIamMemberArgs{
			Api:       pulumi.Any(apiCfg.Api),
			ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
			Role:      pulumi.String("roles/apigateway.viewer"),
			Member:    pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.ApiGateway.ApiConfigIamMember("member", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        Role = "roles/apigateway.viewer",
        Member = "user:jane@example.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiConfigIamMember;
import com.pulumi.gcp.apigateway.ApiConfigIamMemberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var member = new ApiConfigIamMember("member", ApiConfigIamMemberArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .role("roles/apigateway.viewer")
            .member("user:jane@example.com")
            .build());

    }
}

resources:
  member:
    type: gcp:apigateway:ApiConfigIamMember
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      role: roles/apigateway.viewer
      member: user:jane@example.com

ApiConfigIamMember is non-authoritative: it adds one member to a role without removing others. This is the safest option for incremental grants, especially when multiple teams manage access independently. You can create multiple ApiConfigIamMember resources for the same role without conflicts.

Beyond these examples

These snippets focus on specific IAM management approaches: authoritative vs non-authoritative updates, and policy-level, role-level, and member-level control. They’re intentionally minimal rather than full access management solutions.

The examples reference pre-existing infrastructure such as API Gateway API and ApiConfig resources. They focus on IAM binding configuration rather than provisioning the API Gateway resources themselves.

To keep things focused, common IAM patterns are omitted, including:

Project specification (defaults to provider or parent resource)
Conditional IAM bindings
Custom role definitions
Service account creation and management

These omissions are intentional: the goal is to illustrate how each IAM resource type is wired, not provide drop-in access control modules. See the API Gateway ApiConfig IAM Policy resource reference for all available configuration options.

Let's manage GCP API Gateway IAM Policies

Get started with Pulumi Cloud, then follow our quick setup guide to deploy this infrastructure.

Try Pulumi Cloud for FREE

Frequently Asked Questions

Resource Selection & Conflicts

What's the difference between ApiConfigIamPolicy, ApiConfigIamBinding, and ApiConfigIamMember?

Three resources manage IAM policies with different behaviors:

ApiConfigIamPolicy: Authoritative, replaces the entire IAM policy
ApiConfigIamBinding: Authoritative for a specific role, preserves other roles
ApiConfigIamMember: Non-authoritative, adds a single member and preserves existing members

Which IAM resources can I use together?

ApiConfigIamPolicy cannot be used with ApiConfigIamBinding or ApiConfigIamMember because they’ll conflict over the policy. You can use ApiConfigIamBinding with ApiConfigIamMember only if they manage different roles.

Why are my IAM policies conflicting?

Mixing ApiConfigIamPolicy with ApiConfigIamBinding or ApiConfigIamMember causes conflicts because Policy is fully authoritative while the others are additive. Similarly, using ApiConfigIamBinding and ApiConfigIamMember for the same role will conflict.

Configuration & Setup

How do I set up ApiConfigIamPolicy?

Use gcp.organizations.getIAMPolicy to generate policyData, then pass it to ApiConfigIamPolicy along with required properties api, apiConfig, and project.

Do I need a special provider for this resource?

Yes, this resource is in beta and requires the terraform-provider-google-beta provider.

Import & Migration

What identifier formats can I use when importing?

Four formats are supported (from most to least specific):

projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}}
{{project}}/{{api}}/{{api_config}}
{{api}}/{{api_config}}
{{api_config}}

Missing values are taken from the provider configuration.

Using a different cloud?

Explore security guides for other cloud providers:

AWS Guides Azure Guides