published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Turnstile connector and its configuration in a Descope project. Prevent bot attacks on your login pages with the Turnstile connector.
Create TurnstileConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TurnstileConnector(name: string, args: TurnstileConnectorArgs, opts?: CustomResourceOptions);@overload
def TurnstileConnector(resource_name: str,
args: TurnstileConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TurnstileConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
secret_key: Optional[str] = None,
site_key: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None)func NewTurnstileConnector(ctx *Context, name string, args TurnstileConnectorArgs, opts ...ResourceOption) (*TurnstileConnector, error)public TurnstileConnector(string name, TurnstileConnectorArgs args, CustomResourceOptions? opts = null)
public TurnstileConnector(String name, TurnstileConnectorArgs args)
public TurnstileConnector(String name, TurnstileConnectorArgs args, CustomResourceOptions options)
type: descope:TurnstileConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_turnstile_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args TurnstileConnectorArgs
- 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 TurnstileConnectorArgs
- 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 TurnstileConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TurnstileConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TurnstileConnectorArgs
- 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 turnstileConnectorResource = new Descope.TurnstileConnector("turnstileConnectorResource", new()
{
ProjectId = "string",
SecretKey = "string",
SiteKey = "string",
Description = "string",
Disabled = false,
Name = "string",
});
example, err := descope.NewTurnstileConnector(ctx, "turnstileConnectorResource", &descope.TurnstileConnectorArgs{
ProjectId: pulumi.String("string"),
SecretKey: pulumi.String("string"),
SiteKey: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Name: pulumi.String("string"),
})
resource "descope_turnstile_connector" "turnstileConnectorResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
secret_key = "string"
site_key = "string"
description = "string"
disabled = false
name = "string"
}
var turnstileConnectorResource = new TurnstileConnector("turnstileConnectorResource", TurnstileConnectorArgs.builder()
.projectId("string")
.secretKey("string")
.siteKey("string")
.description("string")
.disabled(false)
.name("string")
.build());
turnstile_connector_resource = descope.TurnstileConnector("turnstileConnectorResource",
project_id="string",
secret_key="string",
site_key="string",
description="string",
disabled=False,
name="string")
const turnstileConnectorResource = new descope.TurnstileConnector("turnstileConnectorResource", {
projectId: "string",
secretKey: "string",
siteKey: "string",
description: "string",
disabled: false,
name: "string",
});
type: descope:TurnstileConnector
properties:
description: string
disabled: false
name: string
projectId: string
secretKey: string
siteKey: string
TurnstileConnector 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 TurnstileConnector 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 Turnstile server to verify the user's response.
- Site
Key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- Site
Key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site_
key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site
Key String - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site
Key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site_
key str - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site
Key String - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the TurnstileConnector 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 TurnstileConnector Resource
Get an existing TurnstileConnector 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?: TurnstileConnectorState, opts?: CustomResourceOptions): TurnstileConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
secret_key: Optional[str] = None,
site_key: Optional[str] = None) -> TurnstileConnectorfunc GetTurnstileConnector(ctx *Context, name string, id IDInput, state *TurnstileConnectorState, opts ...ResourceOption) (*TurnstileConnector, error)public static TurnstileConnector Get(string name, Input<string> id, TurnstileConnectorState? state, CustomResourceOptions? opts = null)public static TurnstileConnector get(String name, Output<String> id, TurnstileConnectorState state, CustomResourceOptions options)resources: _: type: descope:TurnstileConnector get: id: ${id}import {
to = descope_turnstile_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.
- 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.
- 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 Turnstile server to verify the user's response.
- Site
Key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- Site
Key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site_
key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site
Key String - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site
Key string - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site_
key str - The site key is used to invoke Turnstile service on your site or mobile application.
- 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.
- 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 Turnstile server to verify the user's response.
- site
Key String - The site key is used to invoke Turnstile 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