1. Registry
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. OauthApp
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse
vercel logo vercel logo
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse

    Provides an OAuth App resource for Sign in with Vercel.

    An OAuth App lets people use their Vercel account to log in to your application via OAuth 2.0 / OpenID Connect. Use the vercel.OauthAppClientSecret resource to generate the client secret your application authenticates with.

    Managing OAuth Apps requires the Owner role on the team.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumiverse/vercel";
    
    const example = new vercel.OauthApp("example", {
        name: "My Example App",
        slug: "my-example-app",
        description: "Lets users sign in to Example with their Vercel account.",
        homePageUri: "https://example.com",
        redirectUris: [
            "https://example.com/api/auth/callback",
            "http://localhost:3000/api/auth/callback",
        ],
        scopes: [
            "openid",
            "email",
            "profile",
            "offline_access",
        ],
        privacyPolicyUrl: "https://example.com/privacy",
        termsOfServiceUrl: "https://example.com/terms",
    });
    
    import pulumi
    import pulumiverse_vercel as vercel
    
    example = vercel.OauthApp("example",
        name="My Example App",
        slug="my-example-app",
        description="Lets users sign in to Example with their Vercel account.",
        home_page_uri="https://example.com",
        redirect_uris=[
            "https://example.com/api/auth/callback",
            "http://localhost:3000/api/auth/callback",
        ],
        scopes=[
            "openid",
            "email",
            "profile",
            "offline_access",
        ],
        privacy_policy_url="https://example.com/privacy",
        terms_of_service_url="https://example.com/terms")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-vercel/sdk/v5/go/vercel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vercel.NewOauthApp(ctx, "example", &vercel.OauthAppArgs{
    			Name:        pulumi.String("My Example App"),
    			Slug:        pulumi.String("my-example-app"),
    			Description: pulumi.String("Lets users sign in to Example with their Vercel account."),
    			HomePageUri: pulumi.String("https://example.com"),
    			RedirectUris: pulumi.StringArray{
    				pulumi.String("https://example.com/api/auth/callback"),
    				pulumi.String("http://localhost:3000/api/auth/callback"),
    			},
    			Scopes: pulumi.StringArray{
    				pulumi.String("openid"),
    				pulumi.String("email"),
    				pulumi.String("profile"),
    				pulumi.String("offline_access"),
    			},
    			PrivacyPolicyUrl:  pulumi.String("https://example.com/privacy"),
    			TermsOfServiceUrl: pulumi.String("https://example.com/terms"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vercel = Pulumiverse.Vercel;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Vercel.OauthApp("example", new()
        {
            Name = "My Example App",
            Slug = "my-example-app",
            Description = "Lets users sign in to Example with their Vercel account.",
            HomePageUri = "https://example.com",
            RedirectUris = new[]
            {
                "https://example.com/api/auth/callback",
                "http://localhost:3000/api/auth/callback",
            },
            Scopes = new[]
            {
                "openid",
                "email",
                "profile",
                "offline_access",
            },
            PrivacyPolicyUrl = "https://example.com/privacy",
            TermsOfServiceUrl = "https://example.com/terms",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumiverse.vercel.OauthApp;
    import com.pulumiverse.vercel.OauthAppArgs;
    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 example = new OauthApp("example", OauthAppArgs.builder()
                .name("My Example App")
                .slug("my-example-app")
                .description("Lets users sign in to Example with their Vercel account.")
                .homePageUri("https://example.com")
                .redirectUris(            
                    "https://example.com/api/auth/callback",
                    "http://localhost:3000/api/auth/callback")
                .scopes(            
                    "openid",
                    "email",
                    "profile",
                    "offline_access")
                .privacyPolicyUrl("https://example.com/privacy")
                .termsOfServiceUrl("https://example.com/terms")
                .build());
    
        }
    }
    
    resources:
      example:
        type: vercel:OauthApp
        properties:
          name: My Example App
          slug: my-example-app
          description: Lets users sign in to Example with their Vercel account.
          homePageUri: https://example.com
          redirectUris:
            - https://example.com/api/auth/callback
            - http://localhost:3000/api/auth/callback
          scopes:
            - openid
            - email
            - profile
            - offline_access
          privacyPolicyUrl: https://example.com/privacy
          termsOfServiceUrl: https://example.com/terms
    
    Example coming soon!
    

    Create OauthApp Resource

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

    Constructor syntax

    new OauthApp(name: string, args: OauthAppArgs, opts?: CustomResourceOptions);
    @overload
    def OauthApp(resource_name: str,
                 args: OauthAppArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def OauthApp(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 slug: Optional[str] = None,
                 code_of_conduct_url: Optional[str] = None,
                 description: Optional[str] = None,
                 home_page_uri: Optional[str] = None,
                 name: Optional[str] = None,
                 privacy_policy_url: Optional[str] = None,
                 redirect_uris: Optional[Sequence[str]] = None,
                 scopes: Optional[Sequence[str]] = None,
                 team_id: Optional[str] = None,
                 terms_of_service_url: Optional[str] = None)
    func NewOauthApp(ctx *Context, name string, args OauthAppArgs, opts ...ResourceOption) (*OauthApp, error)
    public OauthApp(string name, OauthAppArgs args, CustomResourceOptions? opts = null)
    public OauthApp(String name, OauthAppArgs args)
    public OauthApp(String name, OauthAppArgs args, CustomResourceOptions options)
    
    type: vercel:OauthApp
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "vercel_oauth_app" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OauthAppArgs
    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 OauthAppArgs
    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 OauthAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OauthAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OauthAppArgs
    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 oauthAppResource = new Vercel.OauthApp("oauthAppResource", new()
    {
        Slug = "string",
        CodeOfConductUrl = "string",
        Description = "string",
        HomePageUri = "string",
        Name = "string",
        PrivacyPolicyUrl = "string",
        RedirectUris = new[]
        {
            "string",
        },
        Scopes = new[]
        {
            "string",
        },
        TeamId = "string",
        TermsOfServiceUrl = "string",
    });
    
    example, err := vercel.NewOauthApp(ctx, "oauthAppResource", &vercel.OauthAppArgs{
    	Slug:             pulumi.String("string"),
    	CodeOfConductUrl: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	HomePageUri:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	PrivacyPolicyUrl: pulumi.String("string"),
    	RedirectUris: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Scopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TeamId:            pulumi.String("string"),
    	TermsOfServiceUrl: pulumi.String("string"),
    })
    
    resource "vercel_oauth_app" "oauthAppResource" {
      lifecycle {
        create_before_destroy = true
      }
      slug                 = "string"
      code_of_conduct_url  = "string"
      description          = "string"
      home_page_uri        = "string"
      name                 = "string"
      privacy_policy_url   = "string"
      redirect_uris        = ["string"]
      scopes               = ["string"]
      team_id              = "string"
      terms_of_service_url = "string"
    }
    
    var oauthAppResource = new OauthApp("oauthAppResource", OauthAppArgs.builder()
        .slug("string")
        .codeOfConductUrl("string")
        .description("string")
        .homePageUri("string")
        .name("string")
        .privacyPolicyUrl("string")
        .redirectUris("string")
        .scopes("string")
        .teamId("string")
        .termsOfServiceUrl("string")
        .build());
    
    oauth_app_resource = vercel.OauthApp("oauthAppResource",
        slug="string",
        code_of_conduct_url="string",
        description="string",
        home_page_uri="string",
        name="string",
        privacy_policy_url="string",
        redirect_uris=["string"],
        scopes=["string"],
        team_id="string",
        terms_of_service_url="string")
    
    const oauthAppResource = new vercel.OauthApp("oauthAppResource", {
        slug: "string",
        codeOfConductUrl: "string",
        description: "string",
        homePageUri: "string",
        name: "string",
        privacyPolicyUrl: "string",
        redirectUris: ["string"],
        scopes: ["string"],
        teamId: "string",
        termsOfServiceUrl: "string",
    });
    
    type: vercel:OauthApp
    properties:
        codeOfConductUrl: string
        description: string
        homePageUri: string
        name: string
        privacyPolicyUrl: string
        redirectUris:
            - string
        scopes:
            - string
        slug: string
        teamId: string
        termsOfServiceUrl: string
    

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

    Slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    CodeOfConductUrl string
    The URL of the application's code of conduct.
    Description string
    A description of the OAuth App, shown on the consent page.
    HomePageUri string
    The URL of the application's home page.
    Name string
    A human-readable name for the OAuth App, shown on the consent page.
    PrivacyPolicyUrl string
    The URL of the application's privacy policy, shown on the consent page.
    RedirectUris List<string>
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    Scopes List<string>
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    TeamId string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    TermsOfServiceUrl string
    The URL of the application's terms of service, shown on the consent page.
    Slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    CodeOfConductUrl string
    The URL of the application's code of conduct.
    Description string
    A description of the OAuth App, shown on the consent page.
    HomePageUri string
    The URL of the application's home page.
    Name string
    A human-readable name for the OAuth App, shown on the consent page.
    PrivacyPolicyUrl string
    The URL of the application's privacy policy, shown on the consent page.
    RedirectUris []string
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    Scopes []string
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    TeamId string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    TermsOfServiceUrl string
    The URL of the application's terms of service, shown on the consent page.
    slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    code_of_conduct_url string
    The URL of the application's code of conduct.
    description string
    A description of the OAuth App, shown on the consent page.
    home_page_uri string
    The URL of the application's home page.
    name string
    A human-readable name for the OAuth App, shown on the consent page.
    privacy_policy_url string
    The URL of the application's privacy policy, shown on the consent page.
    redirect_uris list(string)
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes list(string)
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    team_id string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    terms_of_service_url string
    The URL of the application's terms of service, shown on the consent page.
    slug String
    A URL-friendly slug for the OAuth App. Must be unique.
    codeOfConductUrl String
    The URL of the application's code of conduct.
    description String
    A description of the OAuth App, shown on the consent page.
    homePageUri String
    The URL of the application's home page.
    name String
    A human-readable name for the OAuth App, shown on the consent page.
    privacyPolicyUrl String
    The URL of the application's privacy policy, shown on the consent page.
    redirectUris List<String>
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes List<String>
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    teamId String
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    termsOfServiceUrl String
    The URL of the application's terms of service, shown on the consent page.
    slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    codeOfConductUrl string
    The URL of the application's code of conduct.
    description string
    A description of the OAuth App, shown on the consent page.
    homePageUri string
    The URL of the application's home page.
    name string
    A human-readable name for the OAuth App, shown on the consent page.
    privacyPolicyUrl string
    The URL of the application's privacy policy, shown on the consent page.
    redirectUris string[]
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes string[]
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    teamId string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    termsOfServiceUrl string
    The URL of the application's terms of service, shown on the consent page.
    slug str
    A URL-friendly slug for the OAuth App. Must be unique.
    code_of_conduct_url str
    The URL of the application's code of conduct.
    description str
    A description of the OAuth App, shown on the consent page.
    home_page_uri str
    The URL of the application's home page.
    name str
    A human-readable name for the OAuth App, shown on the consent page.
    privacy_policy_url str
    The URL of the application's privacy policy, shown on the consent page.
    redirect_uris Sequence[str]
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes Sequence[str]
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    team_id str
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    terms_of_service_url str
    The URL of the application's terms of service, shown on the consent page.
    slug String
    A URL-friendly slug for the OAuth App. Must be unique.
    codeOfConductUrl String
    The URL of the application's code of conduct.
    description String
    A description of the OAuth App, shown on the consent page.
    homePageUri String
    The URL of the application's home page.
    name String
    A human-readable name for the OAuth App, shown on the consent page.
    privacyPolicyUrl String
    The URL of the application's privacy policy, shown on the consent page.
    redirectUris List<String>
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes List<String>
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    teamId String
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    termsOfServiceUrl String
    The URL of the application's terms of service, shown on the consent page.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OauthApp Resource

    Get an existing OauthApp 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?: OauthAppState, opts?: CustomResourceOptions): OauthApp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            code_of_conduct_url: Optional[str] = None,
            description: Optional[str] = None,
            home_page_uri: Optional[str] = None,
            name: Optional[str] = None,
            privacy_policy_url: Optional[str] = None,
            redirect_uris: Optional[Sequence[str]] = None,
            scopes: Optional[Sequence[str]] = None,
            slug: Optional[str] = None,
            team_id: Optional[str] = None,
            terms_of_service_url: Optional[str] = None) -> OauthApp
    func GetOauthApp(ctx *Context, name string, id IDInput, state *OauthAppState, opts ...ResourceOption) (*OauthApp, error)
    public static OauthApp Get(string name, Input<string> id, OauthAppState? state, CustomResourceOptions? opts = null)
    public static OauthApp get(String name, Output<String> id, OauthAppState state, CustomResourceOptions options)
    resources:  _:    type: vercel:OauthApp    get:      id: ${id}
    import {
      to = vercel_oauth_app.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:
    CodeOfConductUrl string
    The URL of the application's code of conduct.
    Description string
    A description of the OAuth App, shown on the consent page.
    HomePageUri string
    The URL of the application's home page.
    Name string
    A human-readable name for the OAuth App, shown on the consent page.
    PrivacyPolicyUrl string
    The URL of the application's privacy policy, shown on the consent page.
    RedirectUris List<string>
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    Scopes List<string>
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    Slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    TeamId string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    TermsOfServiceUrl string
    The URL of the application's terms of service, shown on the consent page.
    CodeOfConductUrl string
    The URL of the application's code of conduct.
    Description string
    A description of the OAuth App, shown on the consent page.
    HomePageUri string
    The URL of the application's home page.
    Name string
    A human-readable name for the OAuth App, shown on the consent page.
    PrivacyPolicyUrl string
    The URL of the application's privacy policy, shown on the consent page.
    RedirectUris []string
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    Scopes []string
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    Slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    TeamId string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    TermsOfServiceUrl string
    The URL of the application's terms of service, shown on the consent page.
    code_of_conduct_url string
    The URL of the application's code of conduct.
    description string
    A description of the OAuth App, shown on the consent page.
    home_page_uri string
    The URL of the application's home page.
    name string
    A human-readable name for the OAuth App, shown on the consent page.
    privacy_policy_url string
    The URL of the application's privacy policy, shown on the consent page.
    redirect_uris list(string)
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes list(string)
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    team_id string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    terms_of_service_url string
    The URL of the application's terms of service, shown on the consent page.
    codeOfConductUrl String
    The URL of the application's code of conduct.
    description String
    A description of the OAuth App, shown on the consent page.
    homePageUri String
    The URL of the application's home page.
    name String
    A human-readable name for the OAuth App, shown on the consent page.
    privacyPolicyUrl String
    The URL of the application's privacy policy, shown on the consent page.
    redirectUris List<String>
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes List<String>
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    slug String
    A URL-friendly slug for the OAuth App. Must be unique.
    teamId String
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    termsOfServiceUrl String
    The URL of the application's terms of service, shown on the consent page.
    codeOfConductUrl string
    The URL of the application's code of conduct.
    description string
    A description of the OAuth App, shown on the consent page.
    homePageUri string
    The URL of the application's home page.
    name string
    A human-readable name for the OAuth App, shown on the consent page.
    privacyPolicyUrl string
    The URL of the application's privacy policy, shown on the consent page.
    redirectUris string[]
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes string[]
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    slug string
    A URL-friendly slug for the OAuth App. Must be unique.
    teamId string
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    termsOfServiceUrl string
    The URL of the application's terms of service, shown on the consent page.
    code_of_conduct_url str
    The URL of the application's code of conduct.
    description str
    A description of the OAuth App, shown on the consent page.
    home_page_uri str
    The URL of the application's home page.
    name str
    A human-readable name for the OAuth App, shown on the consent page.
    privacy_policy_url str
    The URL of the application's privacy policy, shown on the consent page.
    redirect_uris Sequence[str]
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes Sequence[str]
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    slug str
    A URL-friendly slug for the OAuth App. Must be unique.
    team_id str
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    terms_of_service_url str
    The URL of the application's terms of service, shown on the consent page.
    codeOfConductUrl String
    The URL of the application's code of conduct.
    description String
    A description of the OAuth App, shown on the consent page.
    homePageUri String
    The URL of the application's home page.
    name String
    A human-readable name for the OAuth App, shown on the consent page.
    privacyPolicyUrl String
    The URL of the application's privacy policy, shown on the consent page.
    redirectUris List<String>
    The authorization callback URLs of the OAuth App. Must be absolute https URLs (http is allowed for loopback addresses only).
    scopes List<String>
    The scopes the OAuth App may request: openid (always required), email, profile, and offline_access (issues refresh tokens). Defaults to ["openid"].
    slug String
    A URL-friendly slug for the OAuth App. Must be unique.
    teamId String
    The ID of the team the OAuth App should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    termsOfServiceUrl String
    The URL of the application's terms of service, shown on the consent page.

    Import

    The pulumi import command can be used, for example:

    If importing into a personal account, or with a team configured on the provider, simply use the client_id.

    $ pulumi import vercel:index/oauthApp:OauthApp example cl_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    If importing to a team, use the team_id and client_id.

    $ pulumi import vercel:index/oauthApp:OauthApp example team_xxxxxxxxxxxxxxxxxxxxxxxx/cl_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    To learn more about importing existing cloud resources, see Importing resources.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial