DefaultSupportedIdpConfig class
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")
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 main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/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
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_identityplatform_defaultsupportedidpconfig" "idp_config" {
enabled = true
idp_id = "playgames.google.com"
client_id = "client-id"
client_secret = "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.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 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
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}}
Constructors
- DefaultSupportedIdpConfig(String name, {DefaultSupportedIdpConfigArgs? args, CustomResourceOptions? options})
-
Creates a new DefaultSupportedIdpConfig.
nameThe Pulumi resource name.argsArguments used to configure this DefaultSupportedIdpConfig. The set of arguments for DefaultSupportedIdpConfig.optionsResource options controlling this resource's behavior. - DefaultSupportedIdpConfig.reference(String urn)
- Creates a typed reference to an existing DefaultSupportedIdpConfig resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
clientId
↔ Output<
String> -
OAuth client ID
latefinal
-
clientSecret
↔ Output<
String> -
OAuth client secret
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
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.
latefinal
-
enabled
↔ Output<
bool?> -
If this IDP allows the user to sign in
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
idpId
↔ Output<
String> -
ID of the IDP. Possible values include:
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The name of the DefaultSupportedIdpConfig resource
latefinal
-
project
↔ Output<
String> -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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, {DefaultSupportedIdpConfigState? state, CustomResourceOptions? options}) → DefaultSupportedIdpConfig -
Gets an existing DefaultSupportedIdpConfig resource's state with the given
nameandid.