Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. OauthAppClientSecret
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

vercel.OauthAppClientSecret

vercel logo vercel logo
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

    Provides a client secret for a vercel.OauthApp (Sign in with Vercel).

    The secret value is only ever returned by the API at creation time and is stored (marked sensitive) in the Terraform state. An OAuth App can have at most two client secrets at a time, so zero-downtime rotation is possible by creating a new secret before destroying the old one (e.g. with pulumi up -replace and create_before_destroy).

    Managing client secrets requires the Owner role on the team.

    This resource cannot be imported, as the API never re-exposes the secret value.

    Create OauthAppClientSecret Resource

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

    Constructor syntax

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

@overload
def OauthAppClientSecret(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         oauth_app_id: Optional[str] = None,
                         team_id: Optional[str] = None)
    func NewOauthAppClientSecret(ctx *Context, name string, args OauthAppClientSecretArgs, opts ...ResourceOption) (*OauthAppClientSecret, error)
    public OauthAppClientSecret(string name, OauthAppClientSecretArgs args, CustomResourceOptions? opts = null)
    public OauthAppClientSecret(String name, OauthAppClientSecretArgs args)
public OauthAppClientSecret(String name, OauthAppClientSecretArgs args, CustomResourceOptions options)

    type: vercel:OauthAppClientSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "vercel_oauth_app_client_secret" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args OauthAppClientSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OauthAppClientSecretArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OauthAppClientSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OauthAppClientSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OauthAppClientSecretArgs
    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 oauthAppClientSecretResource = new Vercel.OauthAppClientSecret("oauthAppClientSecretResource", new()
{
    OauthAppId = "string",
    TeamId = "string",
});

    example, err := vercel.NewOauthAppClientSecret(ctx, "oauthAppClientSecretResource", &vercel.OauthAppClientSecretArgs{
	OauthAppId: pulumi.String("string"),
	TeamId:     pulumi.String("string"),
})

    resource "vercel_oauth_app_client_secret" "oauthAppClientSecretResource" {
  lifecycle {
    create_before_destroy = true
  }
  oauth_app_id = "string"
  team_id      = "string"
}

    var oauthAppClientSecretResource = new OauthAppClientSecret("oauthAppClientSecretResource", OauthAppClientSecretArgs.builder()
    .oauthAppId("string")
    .teamId("string")
    .build());

    oauth_app_client_secret_resource = vercel.OauthAppClientSecret("oauthAppClientSecretResource",
    oauth_app_id="string",
    team_id="string")

    const oauthAppClientSecretResource = new vercel.OauthAppClientSecret("oauthAppClientSecretResource", {
    oauthAppId: "string",
    teamId: "string",
});

    type: vercel:OauthAppClientSecret
properties:
    oauthAppId: string
    teamId: string

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

    OauthAppId string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    TeamId string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    OauthAppId string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    TeamId string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    oauth_app_id string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    team_id string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    oauthAppId String
    The client ID of the OAuth App (cl_...) to generate a secret for.
    teamId String
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    oauthAppId string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    teamId string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    oauth_app_id str
    The client ID of the OAuth App (cl_...) to generate a secret for.
    team_id str
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    oauthAppId String
    The client ID of the OAuth App (cl_...) to generate a secret for.
    teamId String
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OauthAppClientSecret resource produces the following output properties:

    ClientSecret string
    The generated client secret. Only available at creation time; stored in the Terraform state.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastFourChars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    ClientSecret string
    The generated client secret. Only available at creation time; stored in the Terraform state.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastFourChars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    client_secret string
    The generated client secret. Only available at creation time; stored in the Terraform state.
    id string
    The provider-assigned unique ID for this managed resource.
    last_four_chars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    clientSecret String
    The generated client secret. Only available at creation time; stored in the Terraform state.
    id String
    The provider-assigned unique ID for this managed resource.
    lastFourChars String
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    clientSecret string
    The generated client secret. Only available at creation time; stored in the Terraform state.
    id string
    The provider-assigned unique ID for this managed resource.
    lastFourChars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    client_secret str
    The generated client secret. Only available at creation time; stored in the Terraform state.
    id str
    The provider-assigned unique ID for this managed resource.
    last_four_chars str
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    clientSecret String
    The generated client secret. Only available at creation time; stored in the Terraform state.
    id String
    The provider-assigned unique ID for this managed resource.
    lastFourChars String
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.

    Look up Existing OauthAppClientSecret Resource

    Get an existing OauthAppClientSecret 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?: OauthAppClientSecretState, opts?: CustomResourceOptions): OauthAppClientSecret
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_secret: Optional[str] = None,
        last_four_chars: Optional[str] = None,
        oauth_app_id: Optional[str] = None,
        team_id: Optional[str] = None) -> OauthAppClientSecret
    func GetOauthAppClientSecret(ctx *Context, name string, id IDInput, state *OauthAppClientSecretState, opts ...ResourceOption) (*OauthAppClientSecret, error)
    public static OauthAppClientSecret Get(string name, Input<string> id, OauthAppClientSecretState? state, CustomResourceOptions? opts = null)
    public static OauthAppClientSecret get(String name, Output<String> id, OauthAppClientSecretState state, CustomResourceOptions options)
    resources:  _:    type: vercel:OauthAppClientSecret    get:      id: ${id}
    import {
  to = vercel_oauth_app_client_secret.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 generated client secret. Only available at creation time; stored in the Terraform state.
    LastFourChars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    OauthAppId string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    TeamId string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    ClientSecret string
    The generated client secret. Only available at creation time; stored in the Terraform state.
    LastFourChars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    OauthAppId string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    TeamId string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    client_secret string
    The generated client secret. Only available at creation time; stored in the Terraform state.
    last_four_chars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    oauth_app_id string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    team_id string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    clientSecret String
    The generated client secret. Only available at creation time; stored in the Terraform state.
    lastFourChars String
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    oauthAppId String
    The client ID of the OAuth App (cl_...) to generate a secret for.
    teamId String
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    clientSecret string
    The generated client secret. Only available at creation time; stored in the Terraform state.
    lastFourChars string
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    oauthAppId string
    The client ID of the OAuth App (cl_...) to generate a secret for.
    teamId string
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    client_secret str
    The generated client secret. Only available at creation time; stored in the Terraform state.
    last_four_chars str
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    oauth_app_id str
    The client ID of the OAuth App (cl_...) to generate a secret for.
    team_id str
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.
    clientSecret String
    The generated client secret. Only available at creation time; stored in the Terraform state.
    lastFourChars String
    The last four characters of the client secret — the identifier the Vercel API and dashboard use to reference this secret.
    oauthAppId String
    The client ID of the OAuth App (cl_...) to generate a secret for.
    teamId String
    The ID of the team the OAuth App exists under. Required when configuring a team resource if a default team has not been set in the provider.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo vercel logo
    Viewing docs for Vercel v5.21.1
    published on Thursday, Oct 15, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-vercel

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial