OauthIdpConfig

class OauthIdpConfig : KotlinCustomResource

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/v8/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
})
}
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.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 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}}

Properties

Link copied to clipboard
val clientId: Output<String>

The client id of an OAuth client.

Link copied to clipboard
val clientSecret: Output<String>?

The client secret of the OAuth client, to enable OIDC code flow.

Link copied to clipboard
val displayName: Output<String>?

Human friendly display name.

Link copied to clipboard
val enabled: Output<Boolean>?

If this config allows users to sign in with the provider.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val issuer: Output<String>

For OIDC Idps, the issuer identifier.

Link copied to clipboard
val name: Output<String>

The name of the OauthIdpConfig. Must start with oidc..

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
val urn: Output<String>