Client class

> Warning: This resource is deprecated on Jan 22, 2025. After Jan 19, 2026 the gcp.iap.Client Terraform resource will no longer function as intended due to the deprecation of the IAP OAuth Admin APIs. New projects will not be able to use these APIs. March 19, 2026 The IAP OAuth Admin APIs will be permanently shut down. Access to this feature will no longer be available.

Contains the data that describes an Identity Aware Proxy owned client.

> Note: Only internal org clients can be created via declarative tools. External clients must be manually created via the GCP console. This restriction is due to the existing APIs and not lack of support in this tool.

To get more information about Client, see:

• API documentation
• How-to Guides
• Setting up IAP Client

Example Usage

Iap Client

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

const project = new gcp.organizations.Project("project", {
    projectId: "my-project",
    name: "my-project",
    orgId: "123456789",
    deletionPolicy: "DELETE",
});
const projectService = new gcp.projects.Service("project_service", {
    project: project.projectId,
    service: "iap.googleapis.com",
});
const projectBrand = new gcp.iap.Brand("project_brand", {
    supportEmail: "[e-mail]",
    applicationTitle: "Cloud IAP protected Application",
    project: projectService.project,
});
const projectClient = new gcp.iap.Client("project_client", {
    displayName: "Test Client",
    brand: projectBrand.name,
});

import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.Project("project",
    project_id="my-project",
    name="my-project",
    org_id="123456789",
    deletion_policy="DELETE")
project_service = gcp.projects.Service("project_service",
    project=project.project_id,
    service="iap.googleapis.com")
project_brand = gcp.iap.Brand("project_brand",
    support_email="[e-mail]",
    application_title="Cloud IAP protected Application",
    project=project_service.project)
project_client = gcp.iap.Client("project_client",
    display_name="Test Client",
    brand=project_brand.name)

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

return await Deployment.RunAsync(() =>
{
    var project = new Gcp.Organizations.Project("project", new()
    {
        ProjectId = "my-project",
        Name = "my-project",
        OrgId = "123456789",
        DeletionPolicy = "DELETE",
    });

    var projectService = new Gcp.Projects.Service("project_service", new()
    {
        Project = project.ProjectId,
        ServiceName = "iap.googleapis.com",
    });

    var projectBrand = new Gcp.Iap.Brand("project_brand", new()
    {
        SupportEmail = "[e-mail]",
        ApplicationTitle = "Cloud IAP protected Application",
        Project = projectService.Project,
    });

    var projectClient = new Gcp.Iap.Client("project_client", new()
    {
        DisplayName = "Test Client",
        Brand = projectBrand.Name,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
			ProjectId:      pulumi.String("my-project"),
			Name:           pulumi.String("my-project"),
			OrgId:          pulumi.String("123456789"),
			DeletionPolicy: pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		projectService, err := projects.NewService(ctx, "project_service", &projects.ServiceArgs{
			Project: project.ProjectId,
			Service: pulumi.String("iap.googleapis.com"),
		})
		if err != nil {
			return err
		}
		projectBrand, err := iap.NewBrand(ctx, "project_brand", &iap.BrandArgs{
			SupportEmail:     pulumi.String("[e-mail]"),
			ApplicationTitle: pulumi.String("Cloud IAP protected Application"),
			Project:          projectService.Project,
		})
		if err != nil {
			return err
		}
		_, err = iap.NewClient(ctx, "project_client", &iap.ClientArgs{
			DisplayName: pulumi.String("Test Client"),
			Brand:       projectBrand.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_organizations_project" "project" {
  project_id      = "my-project"
  name            = "my-project"
  org_id          = "123456789"
  deletion_policy = "DELETE"
}
resource "gcp_projects_service" "project_service" {
  project = gcp_organizations_project.project.project_id
  service = "iap.googleapis.com"
}
resource "gcp_iap_brand" "project_brand" {
  support_email     = "[e-mail]"
  application_title = "Cloud IAP protected Application"
  project           = gcp_projects_service.project_service.project
}
resource "gcp_iap_client" "project_client" {
  display_name = "Test Client"
  brand        = gcp_iap_brand.project_brand.name
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.iap.Brand;
import com.pulumi.gcp.iap.BrandArgs;
import com.pulumi.gcp.iap.Client;
import com.pulumi.gcp.iap.ClientArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 project = new Project("project", ProjectArgs.builder()
            .projectId("my-project")
            .name("my-project")
            .orgId("123456789")
            .deletionPolicy("DELETE")
            .build());

        var projectService = new Service("projectService", ServiceArgs.builder()
            .project(project.projectId())
            .service("iap.googleapis.com")
            .build());

        var projectBrand = new Brand("projectBrand", BrandArgs.builder()
            .supportEmail("[e-mail]")
            .applicationTitle("Cloud IAP protected Application")
            .project(projectService.project())
            .build());

        var projectClient = new Client("projectClient", ClientArgs.builder()
            .displayName("Test Client")
            .brand(projectBrand.name())
            .build());

    }
}

resources:
  project:
    type: gcp:organizations:Project
    properties:
      projectId: my-project
      name: my-project
      orgId: '123456789'
      deletionPolicy: DELETE
  projectService:
    type: gcp:projects:Service
    name: project_service
    properties:
      project: ${project.projectId}
      service: iap.googleapis.com
  projectBrand:
    type: gcp:iap:Brand
    name: project_brand
    properties:
      supportEmail: [e-mail]
      applicationTitle: Cloud IAP protected Application
      project: ${projectService.project}
  projectClient:
    type: gcp:iap:Client
    name: project_client
    properties:
      displayName: Test Client
      brand: ${projectBrand.name}

Import

Client can be imported using any of these accepted formats:

• {{brand}}/identityAwareProxyClients/{{client_id}}
• {{brand}}/{{client_id}}

When using the pulumi import command, Client can be imported using one of the formats above. For example:

$ pulumi import gcp:iap/client:Client default {{brand}}/identityAwareProxyClients/{{client_id}}
$ pulumi import gcp:iap/client:Client default {{brand}}/{{client_id}}

Constructors

Client(String name, {ClientArgs? args, CustomResourceOptions? options})

Creates a new Client. name The Pulumi resource name. args Arguments used to configure this Client. The set of arguments for Client. options Resource options controlling this resource's behavior.

Client.reference(String urn)

Creates a typed reference to an existing Client resource.

Properties

brand ↔ Output<String>

Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}.

late, final

childResources → Set<Resource>

final, inherited

clientId ↔ Output<String>

Output only. Unique identifier of the OAuth client.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String>

Human-friendly name given to the OAuth client.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secret ↔ Output<String>

Output only. Client secret of the OAuth client. Note: This property is sensitive and will not be displayed in the plan.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ClientState? state, CustomResourceOptions? options}) → Client

Gets an existing Client resource's state with the given name and id.