1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. identityplatform
  5. DefaultSupportedIdpConfig
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.identityplatform.DefaultSupportedIdpConfig

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    Configurations options 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 Default Supported Idp Config Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const idpConfig = new gcp.identityplatform.DefaultSupportedIdpConfig("idp_config", {
        enabled: true,
        idpId: "playgames.google.com",
        clientId: "client-id",
        clientSecret: "secret",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    idp_config = gcp.identityplatform.DefaultSupportedIdpConfig("idp_config",
        enabled=True,
        idp_id="playgames.google.com",
        client_id="client-id",
        client_secret="secret")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/identityplatform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := identityplatform.NewDefaultSupportedIdpConfig(ctx, "idp_config", &identityplatform.DefaultSupportedIdpConfigArgs{
    			Enabled:      pulumi.Bool(true),
    			IdpId:        pulumi.String("playgames.google.com"),
    			ClientId:     pulumi.String("client-id"),
    			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 idpConfig = new Gcp.IdentityPlatform.DefaultSupportedIdpConfig("idp_config", new()
        {
            Enabled = true,
            IdpId = "playgames.google.com",
            ClientId = "client-id",
            ClientSecret = "secret",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.identityplatform.DefaultSupportedIdpConfig;
    import com.pulumi.gcp.identityplatform.DefaultSupportedIdpConfigArgs;
    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 idpConfig = new DefaultSupportedIdpConfig("idpConfig", DefaultSupportedIdpConfigArgs.builder()
                .enabled(true)
                .idpId("playgames.google.com")
                .clientId("client-id")
                .clientSecret("secret")
                .build());
    
        }
    }
    
    resources:
      idpConfig:
        type: gcp:identityplatform:DefaultSupportedIdpConfig
        name: idp_config
        properties:
          enabled: true
          idpId: playgames.google.com
          clientId: client-id
          clientSecret: secret
    

    Create DefaultSupportedIdpConfig Resource

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

    Constructor syntax

    new DefaultSupportedIdpConfig(name: string, args: DefaultSupportedIdpConfigArgs, opts?: CustomResourceOptions);
    @overload
    def DefaultSupportedIdpConfig(resource_name: str,
                                  args: DefaultSupportedIdpConfigArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def DefaultSupportedIdpConfig(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  client_id: Optional[str] = None,
                                  client_secret: Optional[str] = None,
                                  idp_id: Optional[str] = None,
                                  enabled: Optional[bool] = None,
                                  project: Optional[str] = None)
    func NewDefaultSupportedIdpConfig(ctx *Context, name string, args DefaultSupportedIdpConfigArgs, opts ...ResourceOption) (*DefaultSupportedIdpConfig, error)
    public DefaultSupportedIdpConfig(string name, DefaultSupportedIdpConfigArgs args, CustomResourceOptions? opts = null)
    public DefaultSupportedIdpConfig(String name, DefaultSupportedIdpConfigArgs args)
    public DefaultSupportedIdpConfig(String name, DefaultSupportedIdpConfigArgs args, CustomResourceOptions options)
    
    type: gcp:identityplatform:DefaultSupportedIdpConfig
    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 DefaultSupportedIdpConfigArgs
    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 DefaultSupportedIdpConfigArgs
    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 DefaultSupportedIdpConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefaultSupportedIdpConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefaultSupportedIdpConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var defaultSupportedIdpConfigResource = new Gcp.IdentityPlatform.DefaultSupportedIdpConfig("defaultSupportedIdpConfigResource", new()
    {
        ClientId = "string",
        ClientSecret = "string",
        IdpId = "string",
        Enabled = false,
        Project = "string",
    });
    
    example, err := identityplatform.NewDefaultSupportedIdpConfig(ctx, "defaultSupportedIdpConfigResource", &identityplatform.DefaultSupportedIdpConfigArgs{
    	ClientId:     pulumi.String("string"),
    	ClientSecret: pulumi.String("string"),
    	IdpId:        pulumi.String("string"),
    	Enabled:      pulumi.Bool(false),
    	Project:      pulumi.String("string"),
    })
    
    var defaultSupportedIdpConfigResource = new DefaultSupportedIdpConfig("defaultSupportedIdpConfigResource", DefaultSupportedIdpConfigArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .idpId("string")
        .enabled(false)
        .project("string")
        .build());
    
    default_supported_idp_config_resource = gcp.identityplatform.DefaultSupportedIdpConfig("defaultSupportedIdpConfigResource",
        client_id="string",
        client_secret="string",
        idp_id="string",
        enabled=False,
        project="string")
    
    const defaultSupportedIdpConfigResource = new gcp.identityplatform.DefaultSupportedIdpConfig("defaultSupportedIdpConfigResource", {
        clientId: "string",
        clientSecret: "string",
        idpId: "string",
        enabled: false,
        project: "string",
    });
    
    type: gcp:identityplatform:DefaultSupportedIdpConfig
    properties:
        clientId: string
        clientSecret: string
        enabled: false
        idpId: string
        project: string
    

    DefaultSupportedIdpConfig Resource Properties

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

    Inputs

    The DefaultSupportedIdpConfig resource accepts the following input properties:

    ClientId string
    OAuth client ID
    ClientSecret string
    OAuth client secret


    IdpId 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
    Enabled bool
    If this IDP allows the user to sign in
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ClientId string
    OAuth client ID
    ClientSecret string
    OAuth client secret


    IdpId 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
    Enabled bool
    If this IDP allows the user to sign in
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId String
    OAuth client ID
    clientSecret String
    OAuth client secret


    idpId 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
    enabled Boolean
    If this IDP allows the user to sign in
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId string
    OAuth client ID
    clientSecret string
    OAuth client secret


    idpId 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
    enabled boolean
    If this IDP allows the user to sign in
    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
    OAuth client ID
    client_secret str
    OAuth client secret


    idp_id 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
    enabled bool
    If this IDP allows the user to sign in
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId String
    OAuth client ID
    clientSecret String
    OAuth client secret


    idpId 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
    enabled Boolean
    If this IDP allows the user to sign in
    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 DefaultSupportedIdpConfig resource produces the following output properties:

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

    Look up Existing DefaultSupportedIdpConfig Resource

    Get an existing DefaultSupportedIdpConfig 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?: DefaultSupportedIdpConfigState, opts?: CustomResourceOptions): DefaultSupportedIdpConfig
    @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) -> DefaultSupportedIdpConfig
    func GetDefaultSupportedIdpConfig(ctx *Context, name string, id IDInput, state *DefaultSupportedIdpConfigState, opts ...ResourceOption) (*DefaultSupportedIdpConfig, error)
    public static DefaultSupportedIdpConfig Get(string name, Input<string> id, DefaultSupportedIdpConfigState? state, CustomResourceOptions? opts = null)
    public static DefaultSupportedIdpConfig get(String name, Output<String> id, DefaultSupportedIdpConfigState 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
    OAuth client ID
    ClientSecret string
    OAuth client secret


    Enabled bool
    If this IDP allows the user to sign in
    IdpId 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 DefaultSupportedIdpConfig resource
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ClientId string
    OAuth client ID
    ClientSecret string
    OAuth client secret


    Enabled bool
    If this IDP allows the user to sign in
    IdpId 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 DefaultSupportedIdpConfig resource
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId String
    OAuth client ID
    clientSecret String
    OAuth client secret


    enabled Boolean
    If this IDP allows the user to sign in
    idpId 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 DefaultSupportedIdpConfig resource
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId string
    OAuth client ID
    clientSecret string
    OAuth client secret


    enabled boolean
    If this IDP allows the user to sign in
    idpId 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 DefaultSupportedIdpConfig resource
    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
    OAuth client ID
    client_secret str
    OAuth client secret


    enabled bool
    If this IDP allows the user to sign in
    idp_id 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 DefaultSupportedIdpConfig resource
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clientId String
    OAuth client ID
    clientSecret String
    OAuth client secret


    enabled Boolean
    If this IDP allows the user to sign in
    idpId 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 DefaultSupportedIdpConfig resource
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Import

    DefaultSupportedIdpConfig can be imported using any of these accepted formats:

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

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

    • {{idp_id}}

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

    $ pulumi import gcp:identityplatform/defaultSupportedIdpConfig:DefaultSupportedIdpConfig default projects/{{project}}/defaultSupportedIdpConfigs/{{idp_id}}
    
    $ pulumi import gcp:identityplatform/defaultSupportedIdpConfig:DefaultSupportedIdpConfig default {{project}}/{{idp_id}}
    
    $ pulumi import gcp:identityplatform/defaultSupportedIdpConfig:DefaultSupportedIdpConfig default {{idp_id}}
    

    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 v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi