published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Arkose Labs connector and its configuration in a Descope project. Use this connector to integrate with Arkose Labs’ bot and fraud detection.
Create ArkoseConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ArkoseConnector(name: string, args: ArkoseConnectorArgs, opts?: CustomResourceOptions);@overload
def ArkoseConnector(resource_name: str,
args: ArkoseConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ArkoseConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
private_key: Optional[str] = None,
project_id: Optional[str] = None,
public_key: Optional[str] = None,
client_base_url: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None,
verify_base_url: Optional[str] = None)func NewArkoseConnector(ctx *Context, name string, args ArkoseConnectorArgs, opts ...ResourceOption) (*ArkoseConnector, error)public ArkoseConnector(string name, ArkoseConnectorArgs args, CustomResourceOptions? opts = null)
public ArkoseConnector(String name, ArkoseConnectorArgs args)
public ArkoseConnector(String name, ArkoseConnectorArgs args, CustomResourceOptions options)
type: descope:ArkoseConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_arkose_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ArkoseConnectorArgs
- 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 ArkoseConnectorArgs
- 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 ArkoseConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ArkoseConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ArkoseConnectorArgs
- 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 arkoseConnectorResource = new Descope.ArkoseConnector("arkoseConnectorResource", new()
{
PrivateKey = "string",
ProjectId = "string",
PublicKey = "string",
ClientBaseUrl = "string",
Description = "string",
Disabled = false,
Name = "string",
VerifyBaseUrl = "string",
});
example, err := descope.NewArkoseConnector(ctx, "arkoseConnectorResource", &descope.ArkoseConnectorArgs{
PrivateKey: pulumi.String("string"),
ProjectId: pulumi.String("string"),
PublicKey: pulumi.String("string"),
ClientBaseUrl: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Name: pulumi.String("string"),
VerifyBaseUrl: pulumi.String("string"),
})
resource "descope_arkose_connector" "arkoseConnectorResource" {
lifecycle {
create_before_destroy = true
}
private_key = "string"
project_id = "string"
public_key = "string"
client_base_url = "string"
description = "string"
disabled = false
name = "string"
verify_base_url = "string"
}
var arkoseConnectorResource = new ArkoseConnector("arkoseConnectorResource", ArkoseConnectorArgs.builder()
.privateKey("string")
.projectId("string")
.publicKey("string")
.clientBaseUrl("string")
.description("string")
.disabled(false)
.name("string")
.verifyBaseUrl("string")
.build());
arkose_connector_resource = descope.ArkoseConnector("arkoseConnectorResource",
private_key="string",
project_id="string",
public_key="string",
client_base_url="string",
description="string",
disabled=False,
name="string",
verify_base_url="string")
const arkoseConnectorResource = new descope.ArkoseConnector("arkoseConnectorResource", {
privateKey: "string",
projectId: "string",
publicKey: "string",
clientBaseUrl: "string",
description: "string",
disabled: false,
name: "string",
verifyBaseUrl: "string",
});
type: descope:ArkoseConnector
properties:
clientBaseUrl: string
description: string
disabled: false
name: string
privateKey: string
projectId: string
publicKey: string
verifyBaseUrl: string
ArkoseConnector 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 ArkoseConnector resource accepts the following input properties:
- Private
Key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- Public
Key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- Client
Base stringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- Verify
Base stringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- Private
Key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- Public
Key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- Client
Base stringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- Verify
Base stringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- private_
key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public_
key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- client_
base_ stringurl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- verify_
base_ stringurl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- private
Key String - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public
Key String - The public key that's shown in the Keys screen in the Arkose Labs portal.
- client
Base StringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- verify
Base StringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- private
Key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public
Key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- client
Base stringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- verify
Base stringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- private_
key str - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public_
key str - The public key that's shown in the Keys screen in the Arkose Labs portal.
- client_
base_ strurl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- verify_
base_ strurl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- private
Key String - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public
Key String - The public key that's shown in the Keys screen in the Arkose Labs portal.
- client
Base StringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- verify
Base StringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
Outputs
All input properties are implicitly available as output properties. Additionally, the ArkoseConnector 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 ArkoseConnector Resource
Get an existing ArkoseConnector 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?: ArkoseConnectorState, opts?: CustomResourceOptions): ArkoseConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
client_base_url: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None,
private_key: Optional[str] = None,
project_id: Optional[str] = None,
public_key: Optional[str] = None,
verify_base_url: Optional[str] = None) -> ArkoseConnectorfunc GetArkoseConnector(ctx *Context, name string, id IDInput, state *ArkoseConnectorState, opts ...ResourceOption) (*ArkoseConnector, error)public static ArkoseConnector Get(string name, Input<string> id, ArkoseConnectorState? state, CustomResourceOptions? opts = null)public static ArkoseConnector get(String name, Output<String> id, ArkoseConnectorState state, CustomResourceOptions options)resources: existingArkoseConnector: type: descope:ArkoseConnector get: id: ${id}import {
to = descope_arkose_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 ArkoseConnectorState
- 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 ArkoseConnectorState
- 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 ArkoseConnectorState
- 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 ArkoseConnectorState
- 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.
- Client
Base stringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- Private
Key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- Public
Key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- Verify
Base stringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- Client
Base stringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- Private
Key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- Public
Key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- Verify
Base stringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- client_
base_ stringurl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- private_
key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public_
key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- verify_
base_ stringurl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- client
Base StringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- private
Key String - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public
Key String - The public key that's shown in the Keys screen in the Arkose Labs portal.
- verify
Base StringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- client
Base stringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- private
Key string - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public
Key string - The public key that's shown in the Keys screen in the Arkose Labs portal.
- verify
Base stringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- client_
base_ strurl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- private_
key str - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public_
key str - The public key that's shown in the Keys screen in the Arkose Labs portal.
- verify_
base_ strurl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
- client
Base StringUrl - A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of
https://client-api.arkoselabs.com/v2will be used. - 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.
- private
Key String - The private key that can be copied from the Keys screen in the Arkose Labs portal.
- 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.
- public
Key String - The public key that's shown in the Keys screen in the Arkose Labs portal.
- verify
Base StringUrl - A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of
https://verify-api.arkoselabs.com/api/v4will be used.
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