Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. identityplatform
  5. TenantOauthIdpConfig
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.identityplatform.TenantOauthIdpConfig

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

    OIDC IdP configuration for a Identity Toolkit project within a tenant.

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

    Example Usage

    Identity Platform Tenant Oauth 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 tenantOauthIdpConfig = new gcp.identityplatform.TenantOauthIdpConfig("tenant_oauth_idp_config", {
    name: "oidc.oauth-idp-config",
    tenant: tenant.name,
    displayName: "Display Name",
    clientId: "client-id",
    issuer: "issuer",
    enabled: true,
    clientSecret: "secret",
});

    import pulumi
import pulumi_gcp as gcp

tenant = gcp.identityplatform.Tenant("tenant", display_name="tenant")
tenant_oauth_idp_config = gcp.identityplatform.TenantOauthIdpConfig("tenant_oauth_idp_config",
    name="oidc.oauth-idp-config",
    tenant=tenant.name,
    display_name="Display Name",
    client_id="client-id",
    issuer="issuer",
    enabled=True,
    client_secret="secret")

    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.NewTenantOauthIdpConfig(ctx, "tenant_oauth_idp_config", &identityplatform.TenantOauthIdpConfigArgs{
			Name:         pulumi.String("oidc.oauth-idp-config"),
			Tenant:       tenant.Name,
			DisplayName:  pulumi.String("Display Name"),
			ClientId:     pulumi.String("client-id"),
			Issuer:       pulumi.String("issuer"),
			Enabled:      pulumi.Bool(true),
			ClientSecret: pulumi.String("secret"),
		})
		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 tenant = new Gcp.IdentityPlatform.Tenant("tenant", new()
    {
        DisplayName = "tenant",
    });

    var tenantOauthIdpConfig = new Gcp.IdentityPlatform.TenantOauthIdpConfig("tenant_oauth_idp_config", new()
    {
        Name = "oidc.oauth-idp-config",
        Tenant = tenant.Name,
        DisplayName = "Display Name",
        ClientId = "client-id",
        Issuer = "issuer",
        Enabled = true,
        ClientSecret = "secret",
    });

});

    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.TenantOauthIdpConfig;
import com.pulumi.gcp.identityplatform.TenantOauthIdpConfigArgs;
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 tenantOauthIdpConfig = new TenantOauthIdpConfig("tenantOauthIdpConfig", TenantOauthIdpConfigArgs.builder()
            .name("oidc.oauth-idp-config")
            .tenant(tenant.name())
            .displayName("Display Name")
            .clientId("client-id")
            .issuer("issuer")
            .enabled(true)
            .clientSecret("secret")
            .build());

    }
}

    resources:
  tenant:
    type: gcp:identityplatform:Tenant
    properties:
      displayName: tenant
  tenantOauthIdpConfig:
    type: gcp:identityplatform:TenantOauthIdpConfig
    name: tenant_oauth_idp_config
    properties:
      name: oidc.oauth-idp-config
      tenant: ${tenant.name}
      displayName: Display Name
      clientId: client-id
      issuer: issuer
      enabled: true
      clientSecret: secret

    Create TenantOauthIdpConfig Resource

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

    Constructor syntax

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

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

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

    Parameters

    name string
    The unique name of the resource.
    args TenantOauthIdpConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TenantOauthIdpConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TenantOauthIdpConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TenantOauthIdpConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TenantOauthIdpConfigArgs
    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 tenantOauthIdpConfigResource = new Gcp.IdentityPlatform.TenantOauthIdpConfig("tenantOauthIdpConfigResource", new()
{
    ClientId = "string",
    DisplayName = "string",
    Issuer = "string",
    Tenant = "string",
    ClientSecret = "string",
    Enabled = false,
    Name = "string",
    Project = "string",
});

    example, err := identityplatform.NewTenantOauthIdpConfig(ctx, "tenantOauthIdpConfigResource", &identityplatform.TenantOauthIdpConfigArgs{
	ClientId:     pulumi.String("string"),
	DisplayName:  pulumi.String("string"),
	Issuer:       pulumi.String("string"),
	Tenant:       pulumi.String("string"),
	ClientSecret: pulumi.String("string"),
	Enabled:      pulumi.Bool(false),
	Name:         pulumi.String("string"),
	Project:      pulumi.String("string"),
})

    var tenantOauthIdpConfigResource = new TenantOauthIdpConfig("tenantOauthIdpConfigResource", TenantOauthIdpConfigArgs.builder()
    .clientId("string")
    .displayName("string")
    .issuer("string")
    .tenant("string")
    .clientSecret("string")
    .enabled(false)
    .name("string")
    .project("string")
    .build());

    tenant_oauth_idp_config_resource = gcp.identityplatform.TenantOauthIdpConfig("tenantOauthIdpConfigResource",
    client_id="string",
    display_name="string",
    issuer="string",
    tenant="string",
    client_secret="string",
    enabled=False,
    name="string",
    project="string")

    const tenantOauthIdpConfigResource = new gcp.identityplatform.TenantOauthIdpConfig("tenantOauthIdpConfigResource", {
    clientId: "string",
    displayName: "string",
    issuer: "string",
    tenant: "string",
    clientSecret: "string",
    enabled: false,
    name: "string",
    project: "string",
});

    type: gcp:identityplatform:TenantOauthIdpConfig
properties:
    clientId: string
    clientSecret: string
    displayName: string
    enabled: false
    issuer: string
    name: string
    project: string
    tenant: string

    TenantOauthIdpConfig 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 TenantOauthIdpConfig resource accepts the following input properties:

    ClientId string
    The client id of an OAuth client.

    DisplayName string
    Human friendly display name.
    Issuer string
    For OIDC Idps, the issuer identifier.
    Tenant string
    The name of the tenant where this OIDC IDP configuration resource exists
    ClientSecret string
    The client secret of the OAuth client, to enable OIDC code flow.
    Enabled bool
    If this config allows users to sign in with the provider.
    Name string
    The name of the OauthIdpConfig. Must start with oidc..
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ClientId string
    The client id of an OAuth client.

    DisplayName string
    Human friendly display name.
    Issuer string
    For OIDC Idps, the issuer identifier.
    Tenant string
    The name of the tenant where this OIDC IDP configuration resource exists
    ClientSecret string
    The client secret of the OAuth client, to enable OIDC code flow.
    Enabled bool
    If this config allows users to sign in with the provider.
    Name string
    The name of the OauthIdpConfig. Must start with oidc..
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId String
    The client id of an OAuth client.

    displayName String
    Human friendly display name.
    issuer String
    For OIDC Idps, the issuer identifier.
    tenant String
    The name of the tenant where this OIDC IDP configuration resource exists
    clientSecret String
    The client secret of the OAuth client, to enable OIDC code flow.
    enabled Boolean
    If this config allows users to sign in with the provider.
    name String
    The name of the OauthIdpConfig. Must start with oidc..
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId string
    The client id of an OAuth client.

    displayName string
    Human friendly display name.
    issuer string
    For OIDC Idps, the issuer identifier.
    tenant string
    The name of the tenant where this OIDC IDP configuration resource exists
    clientSecret string
    The client secret of the OAuth client, to enable OIDC code flow.
    enabled boolean
    If this config allows users to sign in with the provider.
    name string
    The name of the OauthIdpConfig. Must start with oidc..
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    client_id str
    The client id of an OAuth client.

    display_name str
    Human friendly display name.
    issuer str
    For OIDC Idps, the issuer identifier.
    tenant str
    The name of the tenant where this OIDC IDP configuration resource exists
    client_secret str
    The client secret of the OAuth client, to enable OIDC code flow.
    enabled bool
    If this config allows users to sign in with the provider.
    name str
    The name of the OauthIdpConfig. Must start with oidc..
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId String
    The client id of an OAuth client.

    displayName String
    Human friendly display name.
    issuer String
    For OIDC Idps, the issuer identifier.
    tenant String
    The name of the tenant where this OIDC IDP configuration resource exists
    clientSecret String
    The client secret of the OAuth client, to enable OIDC code flow.
    enabled Boolean
    If this config allows users to sign in with the provider.
    name String
    The name of the OauthIdpConfig. Must start with oidc..
    project 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 TenantOauthIdpConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TenantOauthIdpConfig Resource

    Get an existing TenantOauthIdpConfig 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?: TenantOauthIdpConfigState, opts?: CustomResourceOptions): TenantOauthIdpConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        issuer: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        tenant: Optional[str] = None) -> TenantOauthIdpConfig
    func GetTenantOauthIdpConfig(ctx *Context, name string, id IDInput, state *TenantOauthIdpConfigState, opts ...ResourceOption) (*TenantOauthIdpConfig, error)
    public static TenantOauthIdpConfig Get(string name, Input<string> id, TenantOauthIdpConfigState? state, CustomResourceOptions? opts = null)
    public static TenantOauthIdpConfig get(String name, Output<String> id, TenantOauthIdpConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The client id of an OAuth client.

    ClientSecret string
    The client secret of the OAuth client, to enable OIDC code flow.
    DisplayName string
    Human friendly display name.
    Enabled bool
    If this config allows users to sign in with the provider.
    Issuer string
    For OIDC Idps, the issuer identifier.
    Name string
    The name of the OauthIdpConfig. Must start with oidc..
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Tenant string
    The name of the tenant where this OIDC IDP configuration resource exists
    ClientId string
    The client id of an OAuth client.

    ClientSecret string
    The client secret of the OAuth client, to enable OIDC code flow.
    DisplayName string
    Human friendly display name.
    Enabled bool
    If this config allows users to sign in with the provider.
    Issuer string
    For OIDC Idps, the issuer identifier.
    Name string
    The name of the OauthIdpConfig. Must start with oidc..
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Tenant string
    The name of the tenant where this OIDC IDP configuration resource exists
    clientId String
    The client id of an OAuth client.

    clientSecret String
    The client secret of the OAuth client, to enable OIDC code flow.
    displayName String
    Human friendly display name.
    enabled Boolean
    If this config allows users to sign in with the provider.
    issuer String
    For OIDC Idps, the issuer identifier.
    name String
    The name of the OauthIdpConfig. Must start with oidc..
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    tenant String
    The name of the tenant where this OIDC IDP configuration resource exists
    clientId string
    The client id of an OAuth client.

    clientSecret string
    The client secret of the OAuth client, to enable OIDC code flow.
    displayName string
    Human friendly display name.
    enabled boolean
    If this config allows users to sign in with the provider.
    issuer string
    For OIDC Idps, the issuer identifier.
    name string
    The name of the OauthIdpConfig. Must start with oidc..
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    tenant string
    The name of the tenant where this OIDC IDP configuration resource exists
    client_id str
    The client id of an OAuth client.

    client_secret str
    The client secret of the OAuth client, to enable OIDC code flow.
    display_name str
    Human friendly display name.
    enabled bool
    If this config allows users to sign in with the provider.
    issuer str
    For OIDC Idps, the issuer identifier.
    name str
    The name of the OauthIdpConfig. Must start with oidc..
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    tenant str
    The name of the tenant where this OIDC IDP configuration resource exists
    clientId String
    The client id of an OAuth client.

    clientSecret String
    The client secret of the OAuth client, to enable OIDC code flow.
    displayName String
    Human friendly display name.
    enabled Boolean
    If this config allows users to sign in with the provider.
    issuer String
    For OIDC Idps, the issuer identifier.
    name String
    The name of the OauthIdpConfig. Must start with oidc..
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    tenant String
    The name of the tenant where this OIDC IDP configuration resource exists

    Import

    TenantOauthIdpConfig can be imported using any of these accepted formats:

    • projects/{{project}}/tenants/{{tenant}}/oauthIdpConfigs/{{name}}

    • {{project}}/{{tenant}}/{{name}}

    • {{tenant}}/{{name}}

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

    $ pulumi import gcp:identityplatform/tenantOauthIdpConfig:TenantOauthIdpConfig default projects/{{project}}/tenants/{{tenant}}/oauthIdpConfigs/{{name}}

    $ pulumi import gcp:identityplatform/tenantOauthIdpConfig:TenantOauthIdpConfig default {{project}}/{{tenant}}/{{name}}

    $ pulumi import gcp:identityplatform/tenantOauthIdpConfig:TenantOauthIdpConfig default {{tenant}}/{{name}}

    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.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-gcp