1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. RecaptchaV2Connector
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 a reCAPTCHA v2 connector and its configuration in a Descope project. Use the reCAPTCHA v2 “I’m not a robot” checkbox widget with your flows.

    Create RecaptchaV2Connector Resource

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

    Constructor syntax

    new RecaptchaV2Connector(name: string, args: RecaptchaV2ConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def RecaptchaV2Connector(resource_name: str,
                             args: RecaptchaV2ConnectorArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def RecaptchaV2Connector(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             project_id: Optional[str] = None,
                             secret_key: Optional[str] = None,
                             site_key: Optional[str] = None,
                             assessment_score: Optional[float] = None,
                             bot_threshold: Optional[float] = None,
                             description: Optional[str] = None,
                             disabled: Optional[bool] = None,
                             name: Optional[str] = None,
                             override_assessment: Optional[bool] = None)
    func NewRecaptchaV2Connector(ctx *Context, name string, args RecaptchaV2ConnectorArgs, opts ...ResourceOption) (*RecaptchaV2Connector, error)
    public RecaptchaV2Connector(string name, RecaptchaV2ConnectorArgs args, CustomResourceOptions? opts = null)
    public RecaptchaV2Connector(String name, RecaptchaV2ConnectorArgs args)
    public RecaptchaV2Connector(String name, RecaptchaV2ConnectorArgs args, CustomResourceOptions options)
    
    type: descope:RecaptchaV2Connector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_recaptcha_v2_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RecaptchaV2ConnectorArgs
    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 RecaptchaV2ConnectorArgs
    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 RecaptchaV2ConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RecaptchaV2ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RecaptchaV2ConnectorArgs
    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 recaptchaV2ConnectorResource = new Descope.RecaptchaV2Connector("recaptchaV2ConnectorResource", new()
    {
        ProjectId = "string",
        SecretKey = "string",
        SiteKey = "string",
        AssessmentScore = 0.0,
        BotThreshold = 0.0,
        Description = "string",
        Disabled = false,
        Name = "string",
        OverrideAssessment = false,
    });
    
    example, err := descope.NewRecaptchaV2Connector(ctx, "recaptchaV2ConnectorResource", &descope.RecaptchaV2ConnectorArgs{
    	ProjectId:          pulumi.String("string"),
    	SecretKey:          pulumi.String("string"),
    	SiteKey:            pulumi.String("string"),
    	AssessmentScore:    pulumi.Float64(0),
    	BotThreshold:       pulumi.Float64(0),
    	Description:        pulumi.String("string"),
    	Disabled:           pulumi.Bool(false),
    	Name:               pulumi.String("string"),
    	OverrideAssessment: pulumi.Bool(false),
    })
    
    resource "descope_recaptcha_v2_connector" "recaptchaV2ConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id          = "string"
      secret_key          = "string"
      site_key            = "string"
      assessment_score    = 0
      bot_threshold       = 0
      description         = "string"
      disabled            = false
      name                = "string"
      override_assessment = false
    }
    
    var recaptchaV2ConnectorResource = new RecaptchaV2Connector("recaptchaV2ConnectorResource", RecaptchaV2ConnectorArgs.builder()
        .projectId("string")
        .secretKey("string")
        .siteKey("string")
        .assessmentScore(0.0)
        .botThreshold(0.0)
        .description("string")
        .disabled(false)
        .name("string")
        .overrideAssessment(false)
        .build());
    
    recaptcha_v2_connector_resource = descope.RecaptchaV2Connector("recaptchaV2ConnectorResource",
        project_id="string",
        secret_key="string",
        site_key="string",
        assessment_score=float(0),
        bot_threshold=float(0),
        description="string",
        disabled=False,
        name="string",
        override_assessment=False)
    
    const recaptchaV2ConnectorResource = new descope.RecaptchaV2Connector("recaptchaV2ConnectorResource", {
        projectId: "string",
        secretKey: "string",
        siteKey: "string",
        assessmentScore: 0,
        botThreshold: 0,
        description: "string",
        disabled: false,
        name: "string",
        overrideAssessment: false,
    });
    
    type: descope:RecaptchaV2Connector
    properties:
        assessmentScore: 0
        botThreshold: 0
        description: string
        disabled: false
        name: string
        overrideAssessment: false
        projectId: string
        secretKey: string
        siteKey: string
    

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

    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretKey string
    The secret key used to verify the user's response with Google siteverify.
    SiteKey string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    AssessmentScore double
    When override is enabled, return this score instead of calling Google.
    BotThreshold double
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    OverrideAssessment bool
    Override the default assessment model. Intended for automated testing only.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretKey string
    The secret key used to verify the user's response with Google siteverify.
    SiteKey string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    AssessmentScore float64
    When override is enabled, return this score instead of calling Google.
    BotThreshold float64
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    OverrideAssessment bool
    Override the default assessment model. Intended for automated testing only.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secret_key string
    The secret key used to verify the user's response with Google siteverify.
    site_key string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessment_score number
    When override is enabled, return this score instead of calling Google.
    bot_threshold number
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    override_assessment bool
    Override the default assessment model. Intended for automated testing only.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretKey String
    The secret key used to verify the user's response with Google siteverify.
    siteKey String
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessmentScore Double
    When override is enabled, return this score instead of calling Google.
    botThreshold Double
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    overrideAssessment Boolean
    Override the default assessment model. Intended for automated testing only.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretKey string
    The secret key used to verify the user's response with Google siteverify.
    siteKey string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessmentScore number
    When override is enabled, return this score instead of calling Google.
    botThreshold number
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    overrideAssessment boolean
    Override the default assessment model. Intended for automated testing only.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secret_key str
    The secret key used to verify the user's response with Google siteverify.
    site_key str
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessment_score float
    When override is enabled, return this score instead of calling Google.
    bot_threshold float
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name str
    A custom name for your connector.
    override_assessment bool
    Override the default assessment model. Intended for automated testing only.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretKey String
    The secret key used to verify the user's response with Google siteverify.
    siteKey String
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessmentScore Number
    When override is enabled, return this score instead of calling Google.
    botThreshold Number
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    overrideAssessment Boolean
    Override the default assessment model. Intended for automated testing only.

    Outputs

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

    Get an existing RecaptchaV2Connector 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?: RecaptchaV2ConnectorState, opts?: CustomResourceOptions): RecaptchaV2Connector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            assessment_score: Optional[float] = None,
            bot_threshold: Optional[float] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            override_assessment: Optional[bool] = None,
            project_id: Optional[str] = None,
            secret_key: Optional[str] = None,
            site_key: Optional[str] = None) -> RecaptchaV2Connector
    func GetRecaptchaV2Connector(ctx *Context, name string, id IDInput, state *RecaptchaV2ConnectorState, opts ...ResourceOption) (*RecaptchaV2Connector, error)
    public static RecaptchaV2Connector Get(string name, Input<string> id, RecaptchaV2ConnectorState? state, CustomResourceOptions? opts = null)
    public static RecaptchaV2Connector get(String name, Output<String> id, RecaptchaV2ConnectorState state, CustomResourceOptions options)
    resources:  _:    type: descope:RecaptchaV2Connector    get:      id: ${id}
    import {
      to = descope_recaptcha_v2_connector.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:
    AssessmentScore double
    When override is enabled, return this score instead of calling Google.
    BotThreshold double
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    OverrideAssessment bool
    Override the default assessment model. Intended for automated testing only.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretKey string
    The secret key used to verify the user's response with Google siteverify.
    SiteKey string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    AssessmentScore float64
    When override is enabled, return this score instead of calling Google.
    BotThreshold float64
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    OverrideAssessment bool
    Override the default assessment model. Intended for automated testing only.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretKey string
    The secret key used to verify the user's response with Google siteverify.
    SiteKey string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessment_score number
    When override is enabled, return this score instead of calling Google.
    bot_threshold number
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    override_assessment bool
    Override the default assessment model. Intended for automated testing only.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secret_key string
    The secret key used to verify the user's response with Google siteverify.
    site_key string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessmentScore Double
    When override is enabled, return this score instead of calling Google.
    botThreshold Double
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    overrideAssessment Boolean
    Override the default assessment model. Intended for automated testing only.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretKey String
    The secret key used to verify the user's response with Google siteverify.
    siteKey String
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessmentScore number
    When override is enabled, return this score instead of calling Google.
    botThreshold number
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    overrideAssessment boolean
    Override the default assessment model. Intended for automated testing only.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretKey string
    The secret key used to verify the user's response with Google siteverify.
    siteKey string
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessment_score float
    When override is enabled, return this score instead of calling Google.
    bot_threshold float
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name str
    A custom name for your connector.
    override_assessment bool
    Override the default assessment model. Intended for automated testing only.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secret_key str
    The secret key used to verify the user's response with Google siteverify.
    site_key str
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
    assessmentScore Number
    When override is enabled, return this score instead of calling Google.
    botThreshold Number
    For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    overrideAssessment Boolean
    Override the default assessment model. Intended for automated testing only.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretKey String
    The secret key used to verify the user's response with Google siteverify.
    siteKey String
    The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).

    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