1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. HcaptchaConnector
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 hCaptcha connector and its configuration in a Descope project. hCaptcha can help protect your applications from bots, spam, and other forms of automated abuse.

    Create HcaptchaConnector Resource

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

    Constructor syntax

    new HcaptchaConnector(name: string, args: HcaptchaConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def HcaptchaConnector(resource_name: str,
                          args: HcaptchaConnectorArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def HcaptchaConnector(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 NewHcaptchaConnector(ctx *Context, name string, args HcaptchaConnectorArgs, opts ...ResourceOption) (*HcaptchaConnector, error)
    public HcaptchaConnector(string name, HcaptchaConnectorArgs args, CustomResourceOptions? opts = null)
    public HcaptchaConnector(String name, HcaptchaConnectorArgs args)
    public HcaptchaConnector(String name, HcaptchaConnectorArgs args, CustomResourceOptions options)
    
    type: descope:HcaptchaConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_hcaptcha_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args HcaptchaConnectorArgs
    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 HcaptchaConnectorArgs
    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 HcaptchaConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HcaptchaConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HcaptchaConnectorArgs
    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 hcaptchaConnectorResource = new Descope.HcaptchaConnector("hcaptchaConnectorResource", new()
    {
        ProjectId = "string",
        SecretKey = "string",
        SiteKey = "string",
        AssessmentScore = 0.0,
        BotThreshold = 0.0,
        Description = "string",
        Disabled = false,
        Name = "string",
        OverrideAssessment = false,
    });
    
    example, err := descope.NewHcaptchaConnector(ctx, "hcaptchaConnectorResource", &descope.HcaptchaConnectorArgs{
    	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_hcaptcha_connector" "hcaptchaConnectorResource" {
      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 hcaptchaConnectorResource = new HcaptchaConnector("hcaptchaConnectorResource", HcaptchaConnectorArgs.builder()
        .projectId("string")
        .secretKey("string")
        .siteKey("string")
        .assessmentScore(0.0)
        .botThreshold(0.0)
        .description("string")
        .disabled(false)
        .name("string")
        .overrideAssessment(false)
        .build());
    
    hcaptcha_connector_resource = descope.HcaptchaConnector("hcaptchaConnectorResource",
        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 hcaptchaConnectorResource = new descope.HcaptchaConnector("hcaptchaConnectorResource", {
        projectId: "string",
        secretKey: "string",
        siteKey: "string",
        assessmentScore: 0,
        botThreshold: 0,
        description: "string",
        disabled: false,
        name: "string",
        overrideAssessment: false,
    });
    
    type: descope:HcaptchaConnector
    properties:
        assessmentScore: 0
        botThreshold: 0
        description: string
        disabled: false
        name: string
        overrideAssessment: false
        projectId: string
        secretKey: string
        siteKey: string
    

    HcaptchaConnector 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 HcaptchaConnector 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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    SiteKey string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    AssessmentScore double
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    BotThreshold double
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    SiteKey string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    AssessmentScore float64
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    BotThreshold float64
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    site_key string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessment_score number
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    bot_threshold number
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    siteKey String
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessmentScore Double
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    botThreshold Double
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    siteKey string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessmentScore number
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    botThreshold number
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    site_key str
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessment_score float
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    bot_threshold float
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    siteKey String
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessmentScore Number
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    botThreshold Number
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.

    Outputs

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

    Get an existing HcaptchaConnector 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?: HcaptchaConnectorState, opts?: CustomResourceOptions): HcaptchaConnector
    @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) -> HcaptchaConnector
    func GetHcaptchaConnector(ctx *Context, name string, id IDInput, state *HcaptchaConnectorState, opts ...ResourceOption) (*HcaptchaConnector, error)
    public static HcaptchaConnector Get(string name, Input<string> id, HcaptchaConnectorState? state, CustomResourceOptions? opts = null)
    public static HcaptchaConnector get(String name, Output<String> id, HcaptchaConnectorState state, CustomResourceOptions options)
    resources:  existingHcaptchaConnector:    type: descope:HcaptchaConnector    get:      id: ${id}
    import {
      to = descope_hcaptcha_connector.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 HcaptchaConnectorState
    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 HcaptchaConnectorState
    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 HcaptchaConnectorState
    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 HcaptchaConnectorState
    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:
    AssessmentScore double
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    BotThreshold double
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    SiteKey string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    AssessmentScore float64
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    BotThreshold float64
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    SiteKey string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessment_score number
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    bot_threshold number
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    site_key string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessmentScore Double
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    botThreshold Double
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    siteKey String
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessmentScore number
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    botThreshold number
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    siteKey string
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessment_score float
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    bot_threshold float
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    site_key str
    The site key is used to invoke hCaptcha service on your site or mobile application.
    assessmentScore Number
    When configured, the hCaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
    botThreshold Number
    The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
    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. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
    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 authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
    siteKey String
    The site key is used to invoke hCaptcha service on your site or mobile application.

    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