published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Forter connector and its configuration in a Descope project. Leverage ML-based risk scores for fraud prevention with the Forter connector.
Create ForterConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ForterConnector(name: string, args: ForterConnectorArgs, opts?: CustomResourceOptions);@overload
def ForterConnector(resource_name: str,
args: ForterConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ForterConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
secret_key: Optional[str] = None,
site_id: Optional[str] = None,
api_version: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None,
override_ip_address: Optional[str] = None,
override_user_email: Optional[str] = None,
overrides: Optional[bool] = None)func NewForterConnector(ctx *Context, name string, args ForterConnectorArgs, opts ...ResourceOption) (*ForterConnector, error)public ForterConnector(string name, ForterConnectorArgs args, CustomResourceOptions? opts = null)
public ForterConnector(String name, ForterConnectorArgs args)
public ForterConnector(String name, ForterConnectorArgs args, CustomResourceOptions options)
type: descope:ForterConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_forter_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ForterConnectorArgs
- 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 ForterConnectorArgs
- 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 ForterConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ForterConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ForterConnectorArgs
- 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 forterConnectorResource = new Descope.ForterConnector("forterConnectorResource", new()
{
ProjectId = "string",
SecretKey = "string",
SiteId = "string",
ApiVersion = "string",
Description = "string",
Disabled = false,
Name = "string",
OverrideIpAddress = "string",
OverrideUserEmail = "string",
Overrides = false,
});
example, err := descope.NewForterConnector(ctx, "forterConnectorResource", &descope.ForterConnectorArgs{
ProjectId: pulumi.String("string"),
SecretKey: pulumi.String("string"),
SiteId: pulumi.String("string"),
ApiVersion: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Name: pulumi.String("string"),
OverrideIpAddress: pulumi.String("string"),
OverrideUserEmail: pulumi.String("string"),
Overrides: pulumi.Bool(false),
})
resource "descope_forter_connector" "forterConnectorResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
secret_key = "string"
site_id = "string"
api_version = "string"
description = "string"
disabled = false
name = "string"
override_ip_address = "string"
override_user_email = "string"
overrides = false
}
var forterConnectorResource = new ForterConnector("forterConnectorResource", ForterConnectorArgs.builder()
.projectId("string")
.secretKey("string")
.siteId("string")
.apiVersion("string")
.description("string")
.disabled(false)
.name("string")
.overrideIpAddress("string")
.overrideUserEmail("string")
.overrides(false)
.build());
forter_connector_resource = descope.ForterConnector("forterConnectorResource",
project_id="string",
secret_key="string",
site_id="string",
api_version="string",
description="string",
disabled=False,
name="string",
override_ip_address="string",
override_user_email="string",
overrides=False)
const forterConnectorResource = new descope.ForterConnector("forterConnectorResource", {
projectId: "string",
secretKey: "string",
siteId: "string",
apiVersion: "string",
description: "string",
disabled: false,
name: "string",
overrideIpAddress: "string",
overrideUserEmail: "string",
overrides: false,
});
type: descope:ForterConnector
properties:
apiVersion: string
description: string
disabled: false
name: string
overrideIpAddress: string
overrideUserEmail: string
overrides: false
projectId: string
secretKey: string
siteId: string
ForterConnector 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 ForterConnector 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 Forter secret key.
- Site
Id string - The Forter site ID.
- Api
Version string - The Forter API version.
- 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
Ip stringAddress - Override the user IP address.
- Override
User stringEmail - Override the user email.
- Overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- Site
Id string - The Forter site ID.
- Api
Version string - The Forter API version.
- 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
Ip stringAddress - Override the user IP address.
- Override
User stringEmail - Override the user email.
- Overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site_
id string - The Forter site ID.
- api_
version string - The Forter API version.
- 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_
ip_ stringaddress - Override the user IP address.
- override_
user_ stringemail - Override the user email.
- overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site
Id String - The Forter site ID.
- api
Version String - The Forter API version.
- 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
Ip StringAddress - Override the user IP address.
- override
User StringEmail - Override the user email.
- overrides Boolean
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site
Id string - The Forter site ID.
- api
Version string - The Forter API version.
- 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
Ip stringAddress - Override the user IP address.
- override
User stringEmail - Override the user email.
- overrides boolean
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site_
id str - The Forter site ID.
- api_
version str - The Forter API version.
- 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_
ip_ straddress - Override the user IP address.
- override_
user_ stremail - Override the user email.
- overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site
Id String - The Forter site ID.
- api
Version String - The Forter API version.
- 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
Ip StringAddress - Override the user IP address.
- override
User StringEmail - Override the user email.
- overrides Boolean
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose and should not be utilized in production environments.
Outputs
All input properties are implicitly available as output properties. Additionally, the ForterConnector 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 ForterConnector Resource
Get an existing ForterConnector 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?: ForterConnectorState, opts?: CustomResourceOptions): ForterConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_version: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None,
override_ip_address: Optional[str] = None,
override_user_email: Optional[str] = None,
overrides: Optional[bool] = None,
project_id: Optional[str] = None,
secret_key: Optional[str] = None,
site_id: Optional[str] = None) -> ForterConnectorfunc GetForterConnector(ctx *Context, name string, id IDInput, state *ForterConnectorState, opts ...ResourceOption) (*ForterConnector, error)public static ForterConnector Get(string name, Input<string> id, ForterConnectorState? state, CustomResourceOptions? opts = null)public static ForterConnector get(String name, Output<String> id, ForterConnectorState state, CustomResourceOptions options)resources: existingForterConnector: type: descope:ForterConnector get: id: ${id}import {
to = descope_forter_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 ForterConnectorState
- 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 ForterConnectorState
- 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 ForterConnectorState
- 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 ForterConnectorState
- 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.
- Api
Version string - The Forter API version.
- 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
Ip stringAddress - Override the user IP address.
- Override
User stringEmail - Override the user email.
- Overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- Site
Id string - The Forter site ID.
- Api
Version string - The Forter API version.
- 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
Ip stringAddress - Override the user IP address.
- Override
User stringEmail - Override the user email.
- Overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- Site
Id string - The Forter site ID.
- api_
version string - The Forter API version.
- 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_
ip_ stringaddress - Override the user IP address.
- override_
user_ stringemail - Override the user email.
- overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site_
id string - The Forter site ID.
- api
Version String - The Forter API version.
- 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
Ip StringAddress - Override the user IP address.
- override
User StringEmail - Override the user email.
- overrides Boolean
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site
Id String - The Forter site ID.
- api
Version string - The Forter API version.
- 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
Ip stringAddress - Override the user IP address.
- override
User stringEmail - Override the user email.
- overrides boolean
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site
Id string - The Forter site ID.
- api_
version str - The Forter API version.
- 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_
ip_ straddress - Override the user IP address.
- override_
user_ stremail - Override the user email.
- overrides bool
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site_
id str - The Forter site ID.
- api
Version String - The Forter API version.
- 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
Ip StringAddress - Override the user IP address.
- override
User StringEmail - Override the user email.
- overrides Boolean
- Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose 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 Forter secret key.
- site
Id String - The Forter site ID.
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