OauthIdpConfig class

OIDC IdP configuration for a Identity Toolkit project.

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

Example Usage

Identity Platform Oauth Idp Config Basic

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

const oauthIdpConfig = new gcp.identityplatform.OauthIdpConfig("oauth_idp_config", {
    name: "oidc.oauth-idp-config",
    displayName: "Display Name",
    clientId: "client-id",
    issuer: "issuer",
    enabled: true,
    clientSecret: "secret",
    responseType: {
        idToken: true,
        code: false,
    },
});

import pulumi
import pulumi_gcp as gcp

oauth_idp_config = gcp.identityplatform.OauthIdpConfig("oauth_idp_config",
    name="oidc.oauth-idp-config",
    display_name="Display Name",
    client_id="client-id",
    issuer="issuer",
    enabled=True,
    client_secret="secret",
    response_type={
        "id_token": True,
        "code": False,
    })

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

return await Deployment.RunAsync(() =>
{
    var oauthIdpConfig = new Gcp.IdentityPlatform.OauthIdpConfig("oauth_idp_config", new()
    {
        Name = "oidc.oauth-idp-config",
        DisplayName = "Display Name",
        ClientId = "client-id",
        Issuer = "issuer",
        Enabled = true,
        ClientSecret = "secret",
        ResponseType = new Gcp.IdentityPlatform.Inputs.OauthIdpConfigResponseTypeArgs
        {
            IdToken = true,
            Code = false,
        },
    });

});

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.NewOauthIdpConfig(ctx, "oauth_idp_config", &identityplatform.OauthIdpConfigArgs{
			Name:         pulumi.String("oidc.oauth-idp-config"),
			DisplayName:  pulumi.String("Display Name"),
			ClientId:     pulumi.String("client-id"),
			Issuer:       pulumi.String("issuer"),
			Enabled:      pulumi.Bool(true),
			ClientSecret: pulumi.String("secret"),
			ResponseType: &identityplatform.OauthIdpConfigResponseTypeArgs{
				IdToken: pulumi.Bool(true),
				Code:    pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_identityplatform_oauthidpconfig" "oauth_idp_config" {
  name          = "oidc.oauth-idp-config"
  display_name  = "Display Name"
  client_id     = "client-id"
  issuer        = "issuer"
  enabled       = true
  client_secret = "secret"
  response_type = {
    id_token = true
    code     = false
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.identityplatform.OauthIdpConfig;
import com.pulumi.gcp.identityplatform.OauthIdpConfigArgs;
import com.pulumi.gcp.identityplatform.inputs.OauthIdpConfigResponseTypeArgs;
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 oauthIdpConfig = new OauthIdpConfig("oauthIdpConfig", OauthIdpConfigArgs.builder()
            .name("oidc.oauth-idp-config")
            .displayName("Display Name")
            .clientId("client-id")
            .issuer("issuer")
            .enabled(true)
            .clientSecret("secret")
            .responseType(OauthIdpConfigResponseTypeArgs.builder()
                .idToken(true)
                .code(false)
                .build())
            .build());

    }
}

resources:
  oauthIdpConfig:
    type: gcp:identityplatform:OauthIdpConfig
    name: oauth_idp_config
    properties:
      name: oidc.oauth-idp-config
      displayName: Display Name
      clientId: client-id
      issuer: issuer
      enabled: true
      clientSecret: secret
      responseType:
        idToken: true
        code: false

Import

OauthIdpConfig can be imported using any of these accepted formats:

projects/{{project}}/oauthIdpConfigs/{{name}}
{{project}}/{{name}}
{{name}}

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

$ pulumi import gcp:identityplatform/oauthIdpConfig:OauthIdpConfig default projects/{{project}}/oauthIdpConfigs/{{name}}
$ pulumi import gcp:identityplatform/oauthIdpConfig:OauthIdpConfig default {{project}}/{{name}}
$ pulumi import gcp:identityplatform/oauthIdpConfig:OauthIdpConfig default {{name}}

Constructors

OauthIdpConfig(String name, {OauthIdpConfigArgs? args, CustomResourceOptions? options}): Creates a new OauthIdpConfig. name The Pulumi resource name. args Arguments used to configure this OauthIdpConfig. The set of arguments for OauthIdpConfig. options Resource options controlling this resource's behavior.
OauthIdpConfig.reference(String urn): Creates a typed reference to an existing OauthIdpConfig resource.

Properties

childResources → Set<Resource>: finalinherited
clientId ↔ Output<String>: The client id of an OAuth client.
latefinal
clientSecret ↔ Output<String?>: The client secret of the OAuth client, to enable OIDC code flow.
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
displayName ↔ Output<String?>: Human friendly display name.
latefinal
enabled ↔ Output<bool?>: If this config allows users to sign in with the provider.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
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
issuer ↔ Output<String>: For OIDC Idps, the issuer identifier.
latefinal
name ↔ Output<String>: The name of the OauthIdpConfig. Must start with oidc..
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
responseType ↔ Output<OauthIdpConfigResponseType?>: The response type to request for in the OAuth authorization flow. You can set either idToken or code to true, but not both. Setting both types to be simultaneously true ({code: true, idToken: true}) is not yet supported. Structure is documented below.
latefinal
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, {OauthIdpConfigState? state, CustomResourceOptions? options}) → OauthIdpConfig: Gets an existing OauthIdpConfig resource's state with the given name and id.