1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. OauthSettings
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages the project-level OAuth authentication settings. This is a singleton resource, and its id is always the project ID. Individual OAuth providers are managed with the descope.OauthProvider resource.

    Create OauthSettings Resource

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

    Constructor syntax

    new OauthSettings(name: string, args: OauthSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def OauthSettings(resource_name: str,
                      args: OauthSettingsArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def OauthSettings(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      project_id: Optional[str] = None,
                      disabled: Optional[bool] = None)
    func NewOauthSettings(ctx *Context, name string, args OauthSettingsArgs, opts ...ResourceOption) (*OauthSettings, error)
    public OauthSettings(string name, OauthSettingsArgs args, CustomResourceOptions? opts = null)
    public OauthSettings(String name, OauthSettingsArgs args)
    public OauthSettings(String name, OauthSettingsArgs args, CustomResourceOptions options)
    
    type: descope:OauthSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_oauth_settings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OauthSettingsArgs
    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 OauthSettingsArgs
    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 OauthSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OauthSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OauthSettingsArgs
    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 oauthSettingsResource = new Descope.OauthSettings("oauthSettingsResource", new()
    {
        ProjectId = "string",
        Disabled = false,
    });
    
    example, err := descope.NewOauthSettings(ctx, "oauthSettingsResource", &descope.OauthSettingsArgs{
    	ProjectId: pulumi.String("string"),
    	Disabled:  pulumi.Bool(false),
    })
    
    resource "descope_oauth_settings" "oauthSettingsResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id = "string"
      disabled   = false
    }
    
    var oauthSettingsResource = new OauthSettings("oauthSettingsResource", OauthSettingsArgs.builder()
        .projectId("string")
        .disabled(false)
        .build());
    
    oauth_settings_resource = descope.OauthSettings("oauthSettingsResource",
        project_id="string",
        disabled=False)
    
    const oauthSettingsResource = new descope.OauthSettings("oauthSettingsResource", {
        projectId: "string",
        disabled: false,
    });
    
    type: descope:OauthSettings
    properties:
        disabled: false
        projectId: string
    

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

    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    Disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    Disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    project_id string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled Boolean
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled boolean
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    project_id str
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled Boolean
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OauthSettings 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 OauthSettings Resource

    Get an existing OauthSettings 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?: OauthSettingsState, opts?: CustomResourceOptions): OauthSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            disabled: Optional[bool] = None,
            project_id: Optional[str] = None) -> OauthSettings
    func GetOauthSettings(ctx *Context, name string, id IDInput, state *OauthSettingsState, opts ...ResourceOption) (*OauthSettings, error)
    public static OauthSettings Get(string name, Input<string> id, OauthSettingsState? state, CustomResourceOptions? opts = null)
    public static OauthSettings get(String name, Output<String> id, OauthSettingsState state, CustomResourceOptions options)
    resources:  existingOauthSettings:    type: descope:OauthSettings    get:      id: ${id}
    import {
      to = descope_oauth_settings.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state OauthSettingsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state OauthSettingsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state OauthSettingsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state OauthSettingsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    Disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    Disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    project_id string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled Boolean
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled boolean
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled bool
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    project_id str
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    disabled Boolean
    Setting this to true will disallow using OAuth authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use OAuth.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.

    Package Details

    Repository
    descope descope/pulumi-descope
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial