OauthClient class

Represents an OAuth Client. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.

To get more information about OauthClient, see:

Example Usage

Iam Oauth Client Full

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

const example = new gcp.iam.OauthClient("example", {
    oauthClientId: "example-client-id",
    displayName: "Display Name of OAuth client",
    description: "A sample OAuth client",
    location: "global",
    disabled: false,
    allowedGrantTypes: ["AUTHORIZATION_CODE_GRANT"],
    allowedRedirectUris: ["https://www.example.com"],
    allowedScopes: ["https://www.googleapis.com/auth/cloud-platform"],
    clientType: "CONFIDENTIAL_CLIENT",
});

import pulumi
import pulumi_gcp as gcp

example = gcp.iam.OauthClient("example",
    oauth_client_id="example-client-id",
    display_name="Display Name of OAuth client",
    description="A sample OAuth client",
    location="global",
    disabled=False,
    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")

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

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.Iam.OauthClient("example", new()
    {
        OauthClientId = "example-client-id",
        DisplayName = "Display Name of OAuth client",
        Description = "A sample OAuth client",
        Location = "global",
        Disabled = false,
        AllowedGrantTypes = new[]
        {
            "AUTHORIZATION_CODE_GRANT",
        },
        AllowedRedirectUris = new[]
        {
            "https://www.example.com",
        },
        AllowedScopes = new[]
        {
            "https://www.googleapis.com/auth/cloud-platform",
        },
        ClientType = "CONFIDENTIAL_CLIENT",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.NewOauthClient(ctx, "example", &iam.OauthClientArgs{
			OauthClientId: pulumi.String("example-client-id"),
			DisplayName:   pulumi.String("Display Name of OAuth client"),
			Description:   pulumi.String("A sample OAuth client"),
			Location:      pulumi.String("global"),
			Disabled:      pulumi.Bool(false),
			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
		}
		return nil
	})
}

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

resource "gcp_iam_oauthclient" "example" {
  oauth_client_id       = "example-client-id"
  display_name          = "Display Name of OAuth client"
  description           = "A sample OAuth client"
  location              = "global"
  disabled              = false
  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"
}

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 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 example = new OauthClient("example", OauthClientArgs.builder()
            .oauthClientId("example-client-id")
            .displayName("Display Name of OAuth client")
            .description("A sample OAuth client")
            .location("global")
            .disabled(false)
            .allowedGrantTypes("AUTHORIZATION_CODE_GRANT")
            .allowedRedirectUris("https://www.example.com")
            .allowedScopes("https://www.googleapis.com/auth/cloud-platform")
            .clientType("CONFIDENTIAL_CLIENT")
            .build());

    }
}

resources:
  example:
    type: gcp:iam:OauthClient
    properties:
      oauthClientId: example-client-id
      displayName: Display Name of OAuth client
      description: A sample OAuth client
      location: global
      disabled: false
      allowedGrantTypes:
        - AUTHORIZATION_CODE_GRANT
      allowedRedirectUris:
        - https://www.example.com
      allowedScopes:
        - https://www.googleapis.com/auth/cloud-platform
      clientType: CONFIDENTIAL_CLIENT

Import

OauthClient can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/oauthClients/{{oauth_client_id}}
{{project}}/{{location}}/{{oauth_client_id}}
{{location}}/{{oauth_client_id}}

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

$ pulumi import gcp:iam/oauthClient:OauthClient default projects/{{project}}/locations/{{location}}/oauthClients/{{oauth_client_id}}
$ pulumi import gcp:iam/oauthClient:OauthClient default {{project}}/{{location}}/{{oauth_client_id}}
$ pulumi import gcp:iam/oauthClient:OauthClient default {{location}}/{{oauth_client_id}}

Constructors

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

Properties

allowedGrantTypes ↔ Output<List<String>>: Required. The list of OAuth grant types is allowed for the OauthClient.
latefinal
allowedRedirectUris ↔ Output<List<String>>: Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
latefinal
allowedScopes ↔ Output<List<String>>: Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported:
latefinal
childResources → Set<Resource>: finalinherited
clientId ↔ Output<String>: Output only. The system-generated OauthClient id.
latefinal
clientType ↔ Output<String?>: Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource. Possible values: CLIENT_TYPE_UNSPECIFIED PUBLIC_CLIENT CONFIDENTIAL_CLIENT
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
description ↔ Output<String?>: A user-specified description of the OauthClient. Cannot exceed 256 characters.
latefinal
disabled ↔ Output<bool?>: Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
latefinal
displayName ↔ Output<String?>: A user-specified display name of the OauthClient. Cannot exceed 32 characters.
latefinal
expireTime ↔ Output<String>: Time after which the OauthClient will be permanently purged and cannot be recovered.
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
location ↔ Output<String>: Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
latefinal
name ↔ Output<String>: Immutable. Identifier. The resource name of the OauthClient. Format:projects/{project}/locations/{location}/oauthClients/{oauth_client}.
latefinal
oauthClientId ↔ Output<String>: Required. The ID to use for the OauthClient, which becomes the final component of the resource name. This value should be a string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix gcp- is reserved for use by Google, and may not be specified.
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
state ↔ Output<String>: The state of the OauthClient. Possible values: STATE_UNSPECIFIED ACTIVE DELETED
latefinal
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, {OauthClientState? state, CustomResourceOptions? options}) → OauthClient: Gets an existing OauthClient resource's state with the given name and id.