published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Segment connector and its configuration in a Descope project. Orchestrate customer identity traits and signals from your Descope user journey with the Segment connector.
Create SegmentConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SegmentConnector(name: string, args: SegmentConnectorArgs, opts?: CustomResourceOptions);@overload
def SegmentConnector(resource_name: str,
args: SegmentConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SegmentConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
write_key: Optional[str] = None,
browser_analytics: Optional[bool] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
host: Optional[str] = None,
name: Optional[str] = None,
public_write_key: Optional[str] = None)func NewSegmentConnector(ctx *Context, name string, args SegmentConnectorArgs, opts ...ResourceOption) (*SegmentConnector, error)public SegmentConnector(string name, SegmentConnectorArgs args, CustomResourceOptions? opts = null)
public SegmentConnector(String name, SegmentConnectorArgs args)
public SegmentConnector(String name, SegmentConnectorArgs args, CustomResourceOptions options)
type: descope:SegmentConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_segment_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SegmentConnectorArgs
- 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 SegmentConnectorArgs
- 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 SegmentConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SegmentConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SegmentConnectorArgs
- 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 segmentConnectorResource = new Descope.SegmentConnector("segmentConnectorResource", new()
{
ProjectId = "string",
WriteKey = "string",
BrowserAnalytics = false,
Description = "string",
Disabled = false,
Host = "string",
Name = "string",
PublicWriteKey = "string",
});
example, err := descope.NewSegmentConnector(ctx, "segmentConnectorResource", &descope.SegmentConnectorArgs{
ProjectId: pulumi.String("string"),
WriteKey: pulumi.String("string"),
BrowserAnalytics: pulumi.Bool(false),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Host: pulumi.String("string"),
Name: pulumi.String("string"),
PublicWriteKey: pulumi.String("string"),
})
resource "descope_segment_connector" "segmentConnectorResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
write_key = "string"
browser_analytics = false
description = "string"
disabled = false
host = "string"
name = "string"
public_write_key = "string"
}
var segmentConnectorResource = new SegmentConnector("segmentConnectorResource", SegmentConnectorArgs.builder()
.projectId("string")
.writeKey("string")
.browserAnalytics(false)
.description("string")
.disabled(false)
.host("string")
.name("string")
.publicWriteKey("string")
.build());
segment_connector_resource = descope.SegmentConnector("segmentConnectorResource",
project_id="string",
write_key="string",
browser_analytics=False,
description="string",
disabled=False,
host="string",
name="string",
public_write_key="string")
const segmentConnectorResource = new descope.SegmentConnector("segmentConnectorResource", {
projectId: "string",
writeKey: "string",
browserAnalytics: false,
description: "string",
disabled: false,
host: "string",
name: "string",
publicWriteKey: "string",
});
type: descope:SegmentConnector
properties:
browserAnalytics: false
description: string
disabled: false
host: string
name: string
projectId: string
publicWriteKey: string
writeKey: string
SegmentConnector 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 SegmentConnector 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.
- Write
Key string - The Segment Write Key generated for the Descope service.
- Browser
Analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- Host string
- The base URL of the Segment API, when using a custom domain in Segment.
- Name string
- A custom name for your connector.
- Public
Write stringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- 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.
- Write
Key string - The Segment Write Key generated for the Descope service.
- Browser
Analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- Host string
- The base URL of the Segment API, when using a custom domain in Segment.
- Name string
- A custom name for your connector.
- Public
Write stringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- 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.
- write_
key string - The Segment Write Key generated for the Descope service.
- browser_
analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host string
- The base URL of the Segment API, when using a custom domain in Segment.
- name string
- A custom name for your connector.
- public_
write_ stringkey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- 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.
- write
Key String - The Segment Write Key generated for the Descope service.
- browser
Analytics Boolean - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host String
- The base URL of the Segment API, when using a custom domain in Segment.
- name String
- A custom name for your connector.
- public
Write StringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- 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.
- write
Key string - The Segment Write Key generated for the Descope service.
- browser
Analytics boolean - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host string
- The base URL of the Segment API, when using a custom domain in Segment.
- name string
- A custom name for your connector.
- public
Write stringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- 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.
- write_
key str - The Segment Write Key generated for the Descope service.
- browser_
analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host str
- The base URL of the Segment API, when using a custom domain in Segment.
- name str
- A custom name for your connector.
- public_
write_ strkey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- 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.
- write
Key String - The Segment Write Key generated for the Descope service.
- browser
Analytics Boolean - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host String
- The base URL of the Segment API, when using a custom domain in Segment.
- name String
- A custom name for your connector.
- public
Write StringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
Outputs
All input properties are implicitly available as output properties. Additionally, the SegmentConnector 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 SegmentConnector Resource
Get an existing SegmentConnector 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?: SegmentConnectorState, opts?: CustomResourceOptions): SegmentConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
browser_analytics: Optional[bool] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
host: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
public_write_key: Optional[str] = None,
write_key: Optional[str] = None) -> SegmentConnectorfunc GetSegmentConnector(ctx *Context, name string, id IDInput, state *SegmentConnectorState, opts ...ResourceOption) (*SegmentConnector, error)public static SegmentConnector Get(string name, Input<string> id, SegmentConnectorState? state, CustomResourceOptions? opts = null)public static SegmentConnector get(String name, Output<String> id, SegmentConnectorState state, CustomResourceOptions options)resources: existingSegmentConnector: type: descope:SegmentConnector get: id: ${id}import {
to = descope_segment_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 SegmentConnectorState
- 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 SegmentConnectorState
- 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 SegmentConnectorState
- 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 SegmentConnectorState
- 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.
- Browser
Analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- Host string
- The base URL of the Segment API, when using a custom domain in Segment.
- 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.
- Public
Write stringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- Write
Key string - The Segment Write Key generated for the Descope service.
- Browser
Analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- Host string
- The base URL of the Segment API, when using a custom domain in Segment.
- 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.
- Public
Write stringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- Write
Key string - The Segment Write Key generated for the Descope service.
- browser_
analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host string
- The base URL of the Segment API, when using a custom domain in Segment.
- 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.
- public_
write_ stringkey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- write_
key string - The Segment Write Key generated for the Descope service.
- browser
Analytics Boolean - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host String
- The base URL of the Segment API, when using a custom domain in Segment.
- 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.
- public
Write StringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- write
Key String - The Segment Write Key generated for the Descope service.
- browser
Analytics boolean - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host string
- The base URL of the Segment API, when using a custom domain in Segment.
- 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.
- public
Write stringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- write
Key string - The Segment Write Key generated for the Descope service.
- browser_
analytics bool - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host str
- The base URL of the Segment API, when using a custom domain in Segment.
- 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.
- public_
write_ strkey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- write_
key str - The Segment Write Key generated for the Descope service.
- browser
Analytics Boolean - Load Segment's analytics.js library in your end users' browsers during flows, so Segment can recognize the same visitor across your sites. Loading the library sends no events on its own, and you choose which screens or actions load it.
- 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.
- host String
- The base URL of the Segment API, when using a custom domain in Segment.
- 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.
- public
Write StringKey - The write key of your Segment JavaScript Website source. This is a different Segment source than the Write Key field, and unlike it this value is visible to end users, which is how Segment's browser library works.
- write
Key String - The Segment Write Key generated for the Descope service.
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