Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. identityplatform
  5. TenantDefaultSupportedIdpConfig
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.identityplatform.TenantDefaultSupportedIdpConfig

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

Configurations options for the tenant for authenticating with a the standard set of Identity Toolkit-trusted IDPs.

You must enable the Google Identity Platform in the marketplace prior to using this resource.

Example Usage

Identity Platform Tenant Default Supported Idp Config Basic

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

const tenant = new gcp.identityplatform.Tenant("tenant", {displayName: "tenant"});
const idpConfig = new gcp.identityplatform.TenantDefaultSupportedIdpConfig("idp_config", {
    enabled: true,
    tenant: tenant.name,
    idpId: "playgames.google.com",
    clientId: "my-client-id",
    clientSecret: "secret",
});
Copy
import pulumi
import pulumi_gcp as gcp

tenant = gcp.identityplatform.Tenant("tenant", display_name="tenant")
idp_config = gcp.identityplatform.TenantDefaultSupportedIdpConfig("idp_config",
    enabled=True,
    tenant=tenant.name,
    idp_id="playgames.google.com",
    client_id="my-client-id",
    client_secret="secret")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/identityplatform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tenant, err := identityplatform.NewTenant(ctx, "tenant", &identityplatform.TenantArgs{
			DisplayName: pulumi.String("tenant"),
		})
		if err != nil {
			return err
		}
		_, err = identityplatform.NewTenantDefaultSupportedIdpConfig(ctx, "idp_config", &identityplatform.TenantDefaultSupportedIdpConfigArgs{
			Enabled:      pulumi.Bool(true),
			Tenant:       tenant.Name,
			IdpId:        pulumi.String("playgames.google.com"),
			ClientId:     pulumi.String("my-client-id"),
			ClientSecret: pulumi.String("secret"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var tenant = new Gcp.IdentityPlatform.Tenant("tenant", new()
    {
        DisplayName = "tenant",
    });

    var idpConfig = new Gcp.IdentityPlatform.TenantDefaultSupportedIdpConfig("idp_config", new()
    {
        Enabled = true,
        Tenant = tenant.Name,
        IdpId = "playgames.google.com",
        ClientId = "my-client-id",
        ClientSecret = "secret",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.identityplatform.Tenant;
import com.pulumi.gcp.identityplatform.TenantArgs;
import com.pulumi.gcp.identityplatform.TenantDefaultSupportedIdpConfig;
import com.pulumi.gcp.identityplatform.TenantDefaultSupportedIdpConfigArgs;
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 tenant = new Tenant("tenant", TenantArgs.builder()
            .displayName("tenant")
            .build());

        var idpConfig = new TenantDefaultSupportedIdpConfig("idpConfig", TenantDefaultSupportedIdpConfigArgs.builder()
            .enabled(true)
            .tenant(tenant.name())
            .idpId("playgames.google.com")
            .clientId("my-client-id")
            .clientSecret("secret")
            .build());

    }
}
Copy
resources:
  tenant:
    type: gcp:identityplatform:Tenant
    properties:
      displayName: tenant
  idpConfig:
    type: gcp:identityplatform:TenantDefaultSupportedIdpConfig
    name: idp_config
    properties:
      enabled: true
      tenant: ${tenant.name}
      idpId: playgames.google.com
      clientId: my-client-id
      clientSecret: secret
Copy

Create TenantDefaultSupportedIdpConfig Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TenantDefaultSupportedIdpConfig(name: string, args: TenantDefaultSupportedIdpConfigArgs, opts?: CustomResourceOptions);
@overload
def TenantDefaultSupportedIdpConfig(resource_name: str,
                                    args: TenantDefaultSupportedIdpConfigArgs,
                                    opts: Optional[ResourceOptions] = None)

@overload
def TenantDefaultSupportedIdpConfig(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    client_id: Optional[str] = None,
                                    client_secret: Optional[str] = None,
                                    idp_id: Optional[str] = None,
                                    tenant: Optional[str] = None,
                                    enabled: Optional[bool] = None,
                                    project: Optional[str] = None)
func NewTenantDefaultSupportedIdpConfig(ctx *Context, name string, args TenantDefaultSupportedIdpConfigArgs, opts ...ResourceOption) (*TenantDefaultSupportedIdpConfig, error)
public TenantDefaultSupportedIdpConfig(string name, TenantDefaultSupportedIdpConfigArgs args, CustomResourceOptions? opts = null)
public TenantDefaultSupportedIdpConfig(String name, TenantDefaultSupportedIdpConfigArgs args)
public TenantDefaultSupportedIdpConfig(String name, TenantDefaultSupportedIdpConfigArgs args, CustomResourceOptions options)

type: gcp:identityplatform:TenantDefaultSupportedIdpConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TenantDefaultSupportedIdpConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TenantDefaultSupportedIdpConfigArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TenantDefaultSupportedIdpConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TenantDefaultSupportedIdpConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TenantDefaultSupportedIdpConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var tenantDefaultSupportedIdpConfigResource = new Gcp.IdentityPlatform.TenantDefaultSupportedIdpConfig("tenantDefaultSupportedIdpConfigResource", new()
{
    ClientId = "string",
    ClientSecret = "string",
    IdpId = "string",
    Tenant = "string",
    Enabled = false,
    Project = "string",
});
Copy
example, err := identityplatform.NewTenantDefaultSupportedIdpConfig(ctx, "tenantDefaultSupportedIdpConfigResource", &identityplatform.TenantDefaultSupportedIdpConfigArgs{
	ClientId:     pulumi.String("string"),
	ClientSecret: pulumi.String("string"),
	IdpId:        pulumi.String("string"),
	Tenant:       pulumi.String("string"),
	Enabled:      pulumi.Bool(false),
	Project:      pulumi.String("string"),
})
Copy
var tenantDefaultSupportedIdpConfigResource = new TenantDefaultSupportedIdpConfig("tenantDefaultSupportedIdpConfigResource", TenantDefaultSupportedIdpConfigArgs.builder()
    .clientId("string")
    .clientSecret("string")
    .idpId("string")
    .tenant("string")
    .enabled(false)
    .project("string")
    .build());
Copy
tenant_default_supported_idp_config_resource = gcp.identityplatform.TenantDefaultSupportedIdpConfig("tenantDefaultSupportedIdpConfigResource",
    client_id="string",
    client_secret="string",
    idp_id="string",
    tenant="string",
    enabled=False,
    project="string")
Copy
const tenantDefaultSupportedIdpConfigResource = new gcp.identityplatform.TenantDefaultSupportedIdpConfig("tenantDefaultSupportedIdpConfigResource", {
    clientId: "string",
    clientSecret: "string",
    idpId: "string",
    tenant: "string",
    enabled: false,
    project: "string",
});
Copy
type: gcp:identityplatform:TenantDefaultSupportedIdpConfig
properties:
    clientId: string
    clientSecret: string
    enabled: false
    idpId: string
    project: string
    tenant: string
Copy

TenantDefaultSupportedIdpConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TenantDefaultSupportedIdpConfig resource accepts the following input properties:

ClientId This property is required. string
OAuth client ID
ClientSecret This property is required. string
OAuth client secret

IdpId
This property is required.
Changes to this property will trigger replacement.
string
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
Tenant
This property is required.
Changes to this property will trigger replacement.
string
The name of the tenant where this DefaultSupportedIdpConfig resource exists
Enabled bool
If this IDP allows the user to sign in
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ClientId This property is required. string
OAuth client ID
ClientSecret This property is required. string
OAuth client secret

IdpId
This property is required.
Changes to this property will trigger replacement.
string
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
Tenant
This property is required.
Changes to this property will trigger replacement.
string
The name of the tenant where this DefaultSupportedIdpConfig resource exists
Enabled bool
If this IDP allows the user to sign in
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
clientId This property is required. String
OAuth client ID
clientSecret This property is required. String
OAuth client secret

idpId
This property is required.
Changes to this property will trigger replacement.
String
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
tenant
This property is required.
Changes to this property will trigger replacement.
String
The name of the tenant where this DefaultSupportedIdpConfig resource exists
enabled Boolean
If this IDP allows the user to sign in
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
clientId This property is required. string
OAuth client ID
clientSecret This property is required. string
OAuth client secret

idpId
This property is required.
Changes to this property will trigger replacement.
string
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
tenant
This property is required.
Changes to this property will trigger replacement.
string
The name of the tenant where this DefaultSupportedIdpConfig resource exists
enabled boolean
If this IDP allows the user to sign in
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
client_id This property is required. str
OAuth client ID
client_secret This property is required. str
OAuth client secret

idp_id
This property is required.
Changes to this property will trigger replacement.
str
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
tenant
This property is required.
Changes to this property will trigger replacement.
str
The name of the tenant where this DefaultSupportedIdpConfig resource exists
enabled bool
If this IDP allows the user to sign in
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
clientId This property is required. String
OAuth client ID
clientSecret This property is required. String
OAuth client secret

idpId
This property is required.
Changes to this property will trigger replacement.
String
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
tenant
This property is required.
Changes to this property will trigger replacement.
String
The name of the tenant where this DefaultSupportedIdpConfig resource exists
enabled Boolean
If this IDP allows the user to sign in
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the TenantDefaultSupportedIdpConfig resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the default supported IDP config resource
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the default supported IDP config resource
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the default supported IDP config resource
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the default supported IDP config resource
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the default supported IDP config resource
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the default supported IDP config resource

Look up Existing TenantDefaultSupportedIdpConfig Resource

Get an existing TenantDefaultSupportedIdpConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TenantDefaultSupportedIdpConfigState, opts?: CustomResourceOptions): TenantDefaultSupportedIdpConfig
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        enabled: Optional[bool] = None,
        idp_id: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        tenant: Optional[str] = None) -> TenantDefaultSupportedIdpConfig
func GetTenantDefaultSupportedIdpConfig(ctx *Context, name string, id IDInput, state *TenantDefaultSupportedIdpConfigState, opts ...ResourceOption) (*TenantDefaultSupportedIdpConfig, error)
public static TenantDefaultSupportedIdpConfig Get(string name, Input<string> id, TenantDefaultSupportedIdpConfigState? state, CustomResourceOptions? opts = null)
public static TenantDefaultSupportedIdpConfig get(String name, Output<String> id, TenantDefaultSupportedIdpConfigState state, CustomResourceOptions options)
resources:  _:    type: gcp:identityplatform:TenantDefaultSupportedIdpConfig    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClientId string
OAuth client ID
ClientSecret string
OAuth client secret

Enabled bool
If this IDP allows the user to sign in
IdpId Changes to this property will trigger replacement. string
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
Name string
The name of the default supported IDP config resource
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tenant Changes to this property will trigger replacement. string
The name of the tenant where this DefaultSupportedIdpConfig resource exists
ClientId string
OAuth client ID
ClientSecret string
OAuth client secret

Enabled bool
If this IDP allows the user to sign in
IdpId Changes to this property will trigger replacement. string
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
Name string
The name of the default supported IDP config resource
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tenant Changes to this property will trigger replacement. string
The name of the tenant where this DefaultSupportedIdpConfig resource exists
clientId String
OAuth client ID
clientSecret String
OAuth client secret

enabled Boolean
If this IDP allows the user to sign in
idpId Changes to this property will trigger replacement. String
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
name String
The name of the default supported IDP config resource
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tenant Changes to this property will trigger replacement. String
The name of the tenant where this DefaultSupportedIdpConfig resource exists
clientId string
OAuth client ID
clientSecret string
OAuth client secret

enabled boolean
If this IDP allows the user to sign in
idpId Changes to this property will trigger replacement. string
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
name string
The name of the default supported IDP config resource
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tenant Changes to this property will trigger replacement. string
The name of the tenant where this DefaultSupportedIdpConfig resource exists
client_id str
OAuth client ID
client_secret str
OAuth client secret

enabled bool
If this IDP allows the user to sign in
idp_id Changes to this property will trigger replacement. str
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
name str
The name of the default supported IDP config resource
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tenant Changes to this property will trigger replacement. str
The name of the tenant where this DefaultSupportedIdpConfig resource exists
clientId String
OAuth client ID
clientSecret String
OAuth client secret

enabled Boolean
If this IDP allows the user to sign in
idpId Changes to this property will trigger replacement. String
ID of the IDP. Possible values include:

  • apple.com
  • facebook.com
  • gc.apple.com
  • github.com
  • google.com
  • linkedin.com
  • microsoft.com
  • playgames.google.com
  • twitter.com
  • yahoo.com
name String
The name of the default supported IDP config resource
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tenant Changes to this property will trigger replacement. String
The name of the tenant where this DefaultSupportedIdpConfig resource exists

Import

TenantDefaultSupportedIdpConfig can be imported using any of these accepted formats:

  • projects/{{project}}/tenants/{{tenant}}/defaultSupportedIdpConfigs/{{idp_id}}

  • {{project}}/{{tenant}}/{{idp_id}}

  • {{tenant}}/{{idp_id}}

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

$ pulumi import gcp:identityplatform/tenantDefaultSupportedIdpConfig:TenantDefaultSupportedIdpConfig default projects/{{project}}/tenants/{{tenant}}/defaultSupportedIdpConfigs/{{idp_id}}
Copy
$ pulumi import gcp:identityplatform/tenantDefaultSupportedIdpConfig:TenantDefaultSupportedIdpConfig default {{project}}/{{tenant}}/{{idp_id}}
Copy
$ pulumi import gcp:identityplatform/tenantDefaultSupportedIdpConfig:TenantDefaultSupportedIdpConfig default {{tenant}}/{{idp_id}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp