Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. iam
  5. OauthClientCredential
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.iam.OauthClientCredential

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

Represents an OAuth Client Credential. Used to authenticate an OAuth Client while accessing Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol.

To get more information about OauthClientCredential, see:

Example Usage

Iam Oauth Client Credential Full

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

const oauthClient = new gcp.iam.OauthClient("oauth_client", {
    oauthClientId: "example-client-id",
    location: "global",
    allowedGrantTypes: ["AUTHORIZATION_CODE_GRANT"],
    allowedRedirectUris: ["https://www.example.com"],
    allowedScopes: ["https://www.googleapis.com/auth/cloud-platform"],
    clientType: "CONFIDENTIAL_CLIENT",
});
const example = new gcp.iam.OauthClientCredential("example", {
    oauthclient: oauthClient.oauthClientId,
    location: oauthClient.location,
    oauthClientCredentialId: "cred-id",
    disabled: true,
    displayName: "Display Name of credential",
});
Copy
import pulumi
import pulumi_gcp as gcp

oauth_client = gcp.iam.OauthClient("oauth_client",
    oauth_client_id="example-client-id",
    location="global",
    allowed_grant_types=["AUTHORIZATION_CODE_GRANT"],
    allowed_redirect_uris=["https://www.example.com"],
    allowed_scopes=["https://www.googleapis.com/auth/cloud-platform"],
    client_type="CONFIDENTIAL_CLIENT")
example = gcp.iam.OauthClientCredential("example",
    oauthclient=oauth_client.oauth_client_id,
    location=oauth_client.location,
    oauth_client_credential_id="cred-id",
    disabled=True,
    display_name="Display Name of credential")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		oauthClient, err := iam.NewOauthClient(ctx, "oauth_client", &iam.OauthClientArgs{
			OauthClientId: pulumi.String("example-client-id"),
			Location:      pulumi.String("global"),
			AllowedGrantTypes: pulumi.StringArray{
				pulumi.String("AUTHORIZATION_CODE_GRANT"),
			},
			AllowedRedirectUris: pulumi.StringArray{
				pulumi.String("https://www.example.com"),
			},
			AllowedScopes: pulumi.StringArray{
				pulumi.String("https://www.googleapis.com/auth/cloud-platform"),
			},
			ClientType: pulumi.String("CONFIDENTIAL_CLIENT"),
		})
		if err != nil {
			return err
		}
		_, err = iam.NewOauthClientCredential(ctx, "example", &iam.OauthClientCredentialArgs{
			Oauthclient:             oauthClient.OauthClientId,
			Location:                oauthClient.Location,
			OauthClientCredentialId: pulumi.String("cred-id"),
			Disabled:                pulumi.Bool(true),
			DisplayName:             pulumi.String("Display Name of credential"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var oauthClient = new Gcp.Iam.OauthClient("oauth_client", new()
    {
        OauthClientId = "example-client-id",
        Location = "global",
        AllowedGrantTypes = new[]
        {
            "AUTHORIZATION_CODE_GRANT",
        },
        AllowedRedirectUris = new[]
        {
            "https://www.example.com",
        },
        AllowedScopes = new[]
        {
            "https://www.googleapis.com/auth/cloud-platform",
        },
        ClientType = "CONFIDENTIAL_CLIENT",
    });

    var example = new Gcp.Iam.OauthClientCredential("example", new()
    {
        Oauthclient = oauthClient.OauthClientId,
        Location = oauthClient.Location,
        OauthClientCredentialId = "cred-id",
        Disabled = true,
        DisplayName = "Display Name of credential",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.iam.OauthClient;
import com.pulumi.gcp.iam.OauthClientArgs;
import com.pulumi.gcp.iam.OauthClientCredential;
import com.pulumi.gcp.iam.OauthClientCredentialArgs;
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 oauthClient = new OauthClient("oauthClient", OauthClientArgs.builder()
            .oauthClientId("example-client-id")
            .location("global")
            .allowedGrantTypes("AUTHORIZATION_CODE_GRANT")
            .allowedRedirectUris("https://www.example.com")
            .allowedScopes("https://www.googleapis.com/auth/cloud-platform")
            .clientType("CONFIDENTIAL_CLIENT")
            .build());

        var example = new OauthClientCredential("example", OauthClientCredentialArgs.builder()
            .oauthclient(oauthClient.oauthClientId())
            .location(oauthClient.location())
            .oauthClientCredentialId("cred-id")
            .disabled(true)
            .displayName("Display Name of credential")
            .build());

    }
}
Copy
resources:
  oauthClient:
    type: gcp:iam:OauthClient
    name: oauth_client
    properties:
      oauthClientId: example-client-id
      location: global
      allowedGrantTypes:
        - AUTHORIZATION_CODE_GRANT
      allowedRedirectUris:
        - https://www.example.com
      allowedScopes:
        - https://www.googleapis.com/auth/cloud-platform
      clientType: CONFIDENTIAL_CLIENT
  example:
    type: gcp:iam:OauthClientCredential
    properties:
      oauthclient: ${oauthClient.oauthClientId}
      location: ${oauthClient.location}
      oauthClientCredentialId: cred-id
      disabled: true
      displayName: Display Name of credential
Copy

Create OauthClientCredential Resource

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

Constructor syntax

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

@overload
def OauthClientCredential(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          location: Optional[str] = None,
                          oauth_client_credential_id: Optional[str] = None,
                          oauthclient: Optional[str] = None,
                          disabled: Optional[bool] = None,
                          display_name: Optional[str] = None,
                          project: Optional[str] = None)
func NewOauthClientCredential(ctx *Context, name string, args OauthClientCredentialArgs, opts ...ResourceOption) (*OauthClientCredential, error)
public OauthClientCredential(string name, OauthClientCredentialArgs args, CustomResourceOptions? opts = null)
public OauthClientCredential(String name, OauthClientCredentialArgs args)
public OauthClientCredential(String name, OauthClientCredentialArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OauthClientCredentialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OauthClientCredentialArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OauthClientCredentialArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OauthClientCredentialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OauthClientCredentialArgs
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 oauthClientCredentialResource = new Gcp.Iam.OauthClientCredential("oauthClientCredentialResource", new()
{
    Location = "string",
    OauthClientCredentialId = "string",
    Oauthclient = "string",
    Disabled = false,
    DisplayName = "string",
    Project = "string",
});
Copy
example, err := iam.NewOauthClientCredential(ctx, "oauthClientCredentialResource", &iam.OauthClientCredentialArgs{
	Location:                pulumi.String("string"),
	OauthClientCredentialId: pulumi.String("string"),
	Oauthclient:             pulumi.String("string"),
	Disabled:                pulumi.Bool(false),
	DisplayName:             pulumi.String("string"),
	Project:                 pulumi.String("string"),
})
Copy
var oauthClientCredentialResource = new OauthClientCredential("oauthClientCredentialResource", OauthClientCredentialArgs.builder()
    .location("string")
    .oauthClientCredentialId("string")
    .oauthclient("string")
    .disabled(false)
    .displayName("string")
    .project("string")
    .build());
Copy
oauth_client_credential_resource = gcp.iam.OauthClientCredential("oauthClientCredentialResource",
    location="string",
    oauth_client_credential_id="string",
    oauthclient="string",
    disabled=False,
    display_name="string",
    project="string")
Copy
const oauthClientCredentialResource = new gcp.iam.OauthClientCredential("oauthClientCredentialResource", {
    location: "string",
    oauthClientCredentialId: "string",
    oauthclient: "string",
    disabled: false,
    displayName: "string",
    project: "string",
});
Copy
type: gcp:iam:OauthClientCredential
properties:
    disabled: false
    displayName: string
    location: string
    oauthClientCredentialId: string
    oauthclient: string
    project: string
Copy

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

Location
This property is required.
Changes to this property will trigger replacement.
string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
OauthClientCredentialId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

Oauthclient
This property is required.
Changes to this property will trigger replacement.
string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
Disabled bool
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
DisplayName string
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Location
This property is required.
Changes to this property will trigger replacement.
string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
OauthClientCredentialId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

Oauthclient
This property is required.
Changes to this property will trigger replacement.
string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
Disabled bool
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
DisplayName string
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
location
This property is required.
Changes to this property will trigger replacement.
String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
oauthClientCredentialId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient
This property is required.
Changes to this property will trigger replacement.
String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
disabled Boolean
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
displayName String
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
location
This property is required.
Changes to this property will trigger replacement.
string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
oauthClientCredentialId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient
This property is required.
Changes to this property will trigger replacement.
string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
disabled boolean
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
displayName string
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
location
This property is required.
Changes to this property will trigger replacement.
str
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
oauth_client_credential_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient
This property is required.
Changes to this property will trigger replacement.
str
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
disabled bool
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
display_name str
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
location
This property is required.
Changes to this property will trigger replacement.
String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
oauthClientCredentialId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient
This property is required.
Changes to this property will trigger replacement.
String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
disabled Boolean
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
displayName String
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
project Changes to this property will trigger replacement. 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 OauthClientCredential resource produces the following output properties:

ClientSecret string
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
Id string
The provider-assigned unique ID for this managed resource.
Name string
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
ClientSecret string
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
Id string
The provider-assigned unique ID for this managed resource.
Name string
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
clientSecret String
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
id String
The provider-assigned unique ID for this managed resource.
name String
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
clientSecret string
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
id string
The provider-assigned unique ID for this managed resource.
name string
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
client_secret str
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
id str
The provider-assigned unique ID for this managed resource.
name str
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
clientSecret String
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
id String
The provider-assigned unique ID for this managed resource.
name String
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}

Look up Existing OauthClientCredential Resource

Get an existing OauthClientCredential 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?: OauthClientCredentialState, opts?: CustomResourceOptions): OauthClientCredential
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_secret: Optional[str] = None,
        disabled: Optional[bool] = None,
        display_name: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        oauth_client_credential_id: Optional[str] = None,
        oauthclient: Optional[str] = None,
        project: Optional[str] = None) -> OauthClientCredential
func GetOauthClientCredential(ctx *Context, name string, id IDInput, state *OauthClientCredentialState, opts ...ResourceOption) (*OauthClientCredential, error)
public static OauthClientCredential Get(string name, Input<string> id, OauthClientCredentialState? state, CustomResourceOptions? opts = null)
public static OauthClientCredential get(String name, Output<String> id, OauthClientCredentialState state, CustomResourceOptions options)
resources:  _:    type: gcp:iam:OauthClientCredential    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ClientSecret string
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
Disabled bool
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
DisplayName string
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
Location Changes to this property will trigger replacement. string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
Name string
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
OauthClientCredentialId Changes to this property will trigger replacement. string
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

Oauthclient Changes to this property will trigger replacement. string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ClientSecret string
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
Disabled bool
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
DisplayName string
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
Location Changes to this property will trigger replacement. string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
Name string
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
OauthClientCredentialId Changes to this property will trigger replacement. string
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

Oauthclient Changes to this property will trigger replacement. string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
clientSecret String
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
disabled Boolean
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
displayName String
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
location Changes to this property will trigger replacement. String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
name String
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
oauthClientCredentialId Changes to this property will trigger replacement. String
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient Changes to this property will trigger replacement. String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
clientSecret string
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
disabled boolean
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
displayName string
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
location Changes to this property will trigger replacement. string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
name string
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
oauthClientCredentialId Changes to this property will trigger replacement. string
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient Changes to this property will trigger replacement. string
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
client_secret str
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
disabled bool
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
display_name str
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
location Changes to this property will trigger replacement. str
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
name str
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
oauth_client_credential_id Changes to this property will trigger replacement. str
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient Changes to this property will trigger replacement. str
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
clientSecret String
The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations
disabled Boolean
Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
displayName String
A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
location Changes to this property will trigger replacement. String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
name String
Immutable. Identifier. The resource name of the OauthClientCredential. Format: projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}
oauthClientCredentialId Changes to this property will trigger replacement. String
Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.

oauthclient Changes to this property will trigger replacement. String
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Import

OauthClientCredential can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/oauthClients/{{oauthclient}}/credentials/{{oauth_client_credential_id}}

  • {{project}}/{{location}}/{{oauthclient}}/{{oauth_client_credential_id}}

  • {{location}}/{{oauthclient}}/{{oauth_client_credential_id}}

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

$ pulumi import gcp:iam/oauthClientCredential:OauthClientCredential default projects/{{project}}/locations/{{location}}/oauthClients/{{oauthclient}}/credentials/{{oauth_client_credential_id}}
Copy
$ pulumi import gcp:iam/oauthClientCredential:OauthClientCredential default {{project}}/{{location}}/{{oauthclient}}/{{oauth_client_credential_id}}
Copy
$ pulumi import gcp:iam/oauthClientCredential:OauthClientCredential default {{location}}/{{oauthclient}}/{{oauth_client_credential_id}}
Copy

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.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp