published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a reCAPTCHA v3 connector and its configuration in a Descope project. Prevent bot attacks on your login pages with the reCAPTCHA v3 connector.
Create RecaptchaConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RecaptchaConnector(name: string, args: RecaptchaConnectorArgs, opts?: CustomResourceOptions);@overload
def RecaptchaConnector(resource_name: str,
args: RecaptchaConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RecaptchaConnector(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,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None,
override_assessment: Optional[bool] = None)func NewRecaptchaConnector(ctx *Context, name string, args RecaptchaConnectorArgs, opts ...ResourceOption) (*RecaptchaConnector, error)public RecaptchaConnector(string name, RecaptchaConnectorArgs args, CustomResourceOptions? opts = null)
public RecaptchaConnector(String name, RecaptchaConnectorArgs args)
public RecaptchaConnector(String name, RecaptchaConnectorArgs args, CustomResourceOptions options)
type: descope:RecaptchaConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_recaptcha_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args RecaptchaConnectorArgs
- 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 RecaptchaConnectorArgs
- 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 RecaptchaConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RecaptchaConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RecaptchaConnectorArgs
- 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 recaptchaConnectorResource = new Descope.RecaptchaConnector("recaptchaConnectorResource", new()
{
ProjectId = "string",
SecretKey = "string",
SiteKey = "string",
AssessmentScore = 0.0,
Description = "string",
Disabled = false,
Name = "string",
OverrideAssessment = false,
});
example, err := descope.NewRecaptchaConnector(ctx, "recaptchaConnectorResource", &descope.RecaptchaConnectorArgs{
ProjectId: pulumi.String("string"),
SecretKey: pulumi.String("string"),
SiteKey: pulumi.String("string"),
AssessmentScore: pulumi.Float64(0),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Name: pulumi.String("string"),
OverrideAssessment: pulumi.Bool(false),
})
resource "descope_recaptcha_connector" "recaptchaConnectorResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
secret_key = "string"
site_key = "string"
assessment_score = 0
description = "string"
disabled = false
name = "string"
override_assessment = false
}
var recaptchaConnectorResource = new RecaptchaConnector("recaptchaConnectorResource", RecaptchaConnectorArgs.builder()
.projectId("string")
.secretKey("string")
.siteKey("string")
.assessmentScore(0.0)
.description("string")
.disabled(false)
.name("string")
.overrideAssessment(false)
.build());
recaptcha_connector_resource = descope.RecaptchaConnector("recaptchaConnectorResource",
project_id="string",
secret_key="string",
site_key="string",
assessment_score=float(0),
description="string",
disabled=False,
name="string",
override_assessment=False)
const recaptchaConnectorResource = new descope.RecaptchaConnector("recaptchaConnectorResource", {
projectId: "string",
secretKey: "string",
siteKey: "string",
assessmentScore: 0,
description: "string",
disabled: false,
name: "string",
overrideAssessment: false,
});
type: descope:RecaptchaConnector
properties:
assessmentScore: 0
description: string
disabled: false
name: string
overrideAssessment: false
projectId: string
secretKey: string
siteKey: string
RecaptchaConnector 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 RecaptchaConnector resource accepts the following input properties:
- 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 reCAPTCHA server to verify the user's response.
- Site
Key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- Assessment
Score double - When configured, the Recaptcha 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.
- 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 reCAPTCHA server to verify the user's response.
- Site
Key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- Assessment
Score float64 - When configured, the Recaptcha 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.
- 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 reCAPTCHA server to verify the user's response.
- site_
key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment_
score number - When configured, the Recaptcha 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.
- 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 reCAPTCHA server to verify the user's response.
- site
Key String - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment
Score Double - When configured, the Recaptcha 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.
- 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.
- override
Assessment Boolean - 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 reCAPTCHA server to verify the user's response.
- site
Key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment
Score number - When configured, the Recaptcha 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.
- 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.
- override
Assessment 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 reCAPTCHA server to verify the user's response.
- site_
key str - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment_
score float - When configured, the Recaptcha 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.
- 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 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 reCAPTCHA server to verify the user's response.
- site
Key String - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment
Score Number - When configured, the Recaptcha 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.
- 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.
- override
Assessment 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 RecaptchaConnector 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 RecaptchaConnector Resource
Get an existing RecaptchaConnector 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?: RecaptchaConnectorState, opts?: CustomResourceOptions): RecaptchaConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
assessment_score: 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) -> RecaptchaConnectorfunc GetRecaptchaConnector(ctx *Context, name string, id IDInput, state *RecaptchaConnectorState, opts ...ResourceOption) (*RecaptchaConnector, error)public static RecaptchaConnector Get(string name, Input<string> id, RecaptchaConnectorState? state, CustomResourceOptions? opts = null)public static RecaptchaConnector get(String name, Output<String> id, RecaptchaConnectorState state, CustomResourceOptions options)resources: existingRecaptchaConnector: type: descope:RecaptchaConnector get: id: ${id}import {
to = descope_recaptcha_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 RecaptchaConnectorState
- 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 RecaptchaConnectorState
- 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 RecaptchaConnectorState
- 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 RecaptchaConnectorState
- 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.
- Assessment
Score double - When configured, the Recaptcha 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.
- 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 reCAPTCHA server to verify the user's response.
- Site
Key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- Assessment
Score float64 - When configured, the Recaptcha 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.
- 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 reCAPTCHA server to verify the user's response.
- Site
Key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment_
score number - When configured, the Recaptcha 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.
- 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 reCAPTCHA server to verify the user's response.
- site_
key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment
Score Double - When configured, the Recaptcha 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.
- 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.
- override
Assessment Boolean - 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 reCAPTCHA server to verify the user's response.
- site
Key String - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment
Score number - When configured, the Recaptcha 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.
- 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.
- override
Assessment boolean - 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 reCAPTCHA server to verify the user's response.
- site
Key string - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment_
score float - When configured, the Recaptcha 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.
- 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 reCAPTCHA server to verify the user's response.
- site_
key str - The site key is used to invoke reCAPTCHA service on your site or mobile application.
- assessment
Score Number - When configured, the Recaptcha 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.
- 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.
- override
Assessment Boolean - 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 reCAPTCHA server to verify the user's response.
- site
Key String - The site key is used to invoke reCAPTCHA 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
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope