@pulumi/gcp/iam/oauthClient.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * 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:
 *
 * * [API documentation](https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.oauthClients)
 * * How-to Guides
 *     * [Managing OAuth clients](https://cloud.google.com/iam/docs/workforce-manage-oauth-app#manage-clients)
 *
 * ## Example Usage
 *
 * ### Iam Oauth Client Full
 *
 * ```typescript
 * 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
 *
 * 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:
 *
 * ```sh
 * $ pulumi import gcp:iam/oauthClient:OauthClient default projects/{{project}}/locations/{{location}}/oauthClients/{{oauth_client_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:iam/oauthClient:OauthClient default {{project}}/{{location}}/{{oauth_client_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:iam/oauthClient:OauthClient default {{location}}/{{oauth_client_id}}
 * ```
 */
export declare class OauthClient extends pulumi.CustomResource {
    /**
     * Get an existing OauthClient resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OauthClientState, opts?: pulumi.CustomResourceOptions): OauthClient;
    /**
     * Returns true if the given object is an instance of OauthClient.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is OauthClient;
    /**
     * Required. The list of OAuth grant types is allowed for the OauthClient.
     */
    readonly allowedGrantTypes: pulumi.Output<string[]>;
    /**
     * Required. The list of redirect uris that is allowed to redirect back
     * when authorization process is completed.
     */
    readonly allowedRedirectUris: pulumi.Output<string[]>;
    /**
     * Required. The list of scopes that the OauthClient is allowed to request during
     * OAuth flows.
     * The following scopes are supported:
     * * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure,
     * and delete your Google Cloud data and see the email address for your Google
     * Account.
     */
    readonly allowedScopes: pulumi.Output<string[]>;
    /**
     * Output only. The system-generated OauthClient id.
     */
    readonly clientId: pulumi.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
     */
    readonly clientType: pulumi.Output<string | undefined>;
    /**
     * A user-specified description of the OauthClient.
     * Cannot exceed 256 characters.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Whether the OauthClient is disabled. You cannot use a disabled OAuth
     * client.
     */
    readonly disabled: pulumi.Output<boolean | undefined>;
    /**
     * A user-specified display name of the OauthClient.
     * Cannot exceed 32 characters.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * Time after which the OauthClient will be permanently purged and cannot
     * be recovered.
     */
    readonly expireTime: pulumi.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.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Immutable. Identifier. The resource name of the OauthClient.
     * Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
     */
    readonly name: pulumi.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.
     */
    readonly oauthClientId: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The state of the OauthClient.
     * Possible values:
     * STATE_UNSPECIFIED
     * ACTIVE
     * DELETED
     */
    readonly state: pulumi.Output<string>;
    /**
     * Create a OauthClient resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: OauthClientArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OauthClient resources.
 */
export interface OauthClientState {
    /**
     * Required. The list of OAuth grant types is allowed for the OauthClient.
     */
    allowedGrantTypes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Required. The list of redirect uris that is allowed to redirect back
     * when authorization process is completed.
     */
    allowedRedirectUris?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Required. The list of scopes that the OauthClient is allowed to request during
     * OAuth flows.
     * The following scopes are supported:
     * * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure,
     * and delete your Google Cloud data and see the email address for your Google
     * Account.
     */
    allowedScopes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Output only. The system-generated OauthClient id.
     */
    clientId?: pulumi.Input<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
     */
    clientType?: pulumi.Input<string>;
    /**
     * A user-specified description of the OauthClient.
     * Cannot exceed 256 characters.
     */
    description?: pulumi.Input<string>;
    /**
     * Whether the OauthClient is disabled. You cannot use a disabled OAuth
     * client.
     */
    disabled?: pulumi.Input<boolean>;
    /**
     * A user-specified display name of the OauthClient.
     * Cannot exceed 32 characters.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Time after which the OauthClient will be permanently purged and cannot
     * be recovered.
     */
    expireTime?: pulumi.Input<string>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    location?: pulumi.Input<string>;
    /**
     * Immutable. Identifier. The resource name of the OauthClient.
     * Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
     */
    name?: pulumi.Input<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.
     */
    oauthClientId?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The state of the OauthClient.
     * Possible values:
     * STATE_UNSPECIFIED
     * ACTIVE
     * DELETED
     */
    state?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OauthClient resource.
 */
export interface OauthClientArgs {
    /**
     * Required. The list of OAuth grant types is allowed for the OauthClient.
     */
    allowedGrantTypes: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Required. The list of redirect uris that is allowed to redirect back
     * when authorization process is completed.
     */
    allowedRedirectUris: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Required. The list of scopes that the OauthClient is allowed to request during
     * OAuth flows.
     * The following scopes are supported:
     * * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure,
     * and delete your Google Cloud data and see the email address for your Google
     * Account.
     */
    allowedScopes: pulumi.Input<pulumi.Input<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
     */
    clientType?: pulumi.Input<string>;
    /**
     * A user-specified description of the OauthClient.
     * Cannot exceed 256 characters.
     */
    description?: pulumi.Input<string>;
    /**
     * Whether the OauthClient is disabled. You cannot use a disabled OAuth
     * client.
     */
    disabled?: pulumi.Input<boolean>;
    /**
     * A user-specified display name of the OauthClient.
     * Cannot exceed 32 characters.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    location: pulumi.Input<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.
     */
    oauthClientId: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
}