1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. IntercomConnector
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages a Intercom connector and its configuration in a Descope project. Orchestrate customer identity information from your Descope user journey with the Intercom connector.

    Create IntercomConnector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IntercomConnector(name: string, args: IntercomConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def IntercomConnector(resource_name: str,
                          args: IntercomConnectorArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def IntercomConnector(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          project_id: Optional[str] = None,
                          token: Optional[str] = None,
                          description: Optional[str] = None,
                          disabled: Optional[bool] = None,
                          name: Optional[str] = None,
                          region: Optional[str] = None)
    func NewIntercomConnector(ctx *Context, name string, args IntercomConnectorArgs, opts ...ResourceOption) (*IntercomConnector, error)
    public IntercomConnector(string name, IntercomConnectorArgs args, CustomResourceOptions? opts = null)
    public IntercomConnector(String name, IntercomConnectorArgs args)
    public IntercomConnector(String name, IntercomConnectorArgs args, CustomResourceOptions options)
    
    type: descope:IntercomConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_intercom_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args IntercomConnectorArgs
    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 IntercomConnectorArgs
    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 IntercomConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntercomConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntercomConnectorArgs
    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 intercomConnectorResource = new Descope.IntercomConnector("intercomConnectorResource", new()
    {
        ProjectId = "string",
        Token = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
        Region = "string",
    });
    
    example, err := descope.NewIntercomConnector(ctx, "intercomConnectorResource", &descope.IntercomConnectorArgs{
    	ProjectId:   pulumi.String("string"),
    	Token:       pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Disabled:    pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    	Region:      pulumi.String("string"),
    })
    
    resource "descope_intercom_connector" "intercomConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id  = "string"
      token       = "string"
      description = "string"
      disabled    = false
      name        = "string"
      region      = "string"
    }
    
    var intercomConnectorResource = new IntercomConnector("intercomConnectorResource", IntercomConnectorArgs.builder()
        .projectId("string")
        .token("string")
        .description("string")
        .disabled(false)
        .name("string")
        .region("string")
        .build());
    
    intercom_connector_resource = descope.IntercomConnector("intercomConnectorResource",
        project_id="string",
        token="string",
        description="string",
        disabled=False,
        name="string",
        region="string")
    
    const intercomConnectorResource = new descope.IntercomConnector("intercomConnectorResource", {
        projectId: "string",
        token: "string",
        description: "string",
        disabled: false,
        name: "string",
        region: "string",
    });
    
    type: descope:IntercomConnector
    properties:
        description: string
        disabled: false
        name: string
        projectId: string
        region: string
        token: string
    

    IntercomConnector 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 IntercomConnector resource accepts the following input properties:

    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Token string
    The Intercom access token.
    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.
    Region string
    Regional Hosting - US, EU, or AU. default: US
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Token string
    The Intercom access token.
    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.
    Region string
    Regional Hosting - US, EU, or AU. default: US
    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.
    token string
    The Intercom access token.
    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.
    region string
    Regional Hosting - US, EU, or AU. default: US
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    token String
    The Intercom access token.
    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.
    region String
    Regional Hosting - US, EU, or AU. default: US
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    token string
    The Intercom access token.
    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.
    region string
    Regional Hosting - US, EU, or AU. default: US
    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.
    token str
    The Intercom access token.
    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.
    region str
    Regional Hosting - US, EU, or AU. default: US
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    token String
    The Intercom access token.
    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.
    region String
    Regional Hosting - US, EU, or AU. default: US

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IntercomConnector 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 IntercomConnector Resource

    Get an existing IntercomConnector 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?: IntercomConnectorState, opts?: CustomResourceOptions): IntercomConnector
    @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,
            region: Optional[str] = None,
            token: Optional[str] = None) -> IntercomConnector
    func GetIntercomConnector(ctx *Context, name string, id IDInput, state *IntercomConnectorState, opts ...ResourceOption) (*IntercomConnector, error)
    public static IntercomConnector Get(string name, Input<string> id, IntercomConnectorState? state, CustomResourceOptions? opts = null)
    public static IntercomConnector get(String name, Output<String> id, IntercomConnectorState state, CustomResourceOptions options)
    resources:  existingIntercomConnector:    type: descope:IntercomConnector    get:      id: ${id}
    import {
      to = descope_intercom_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 IntercomConnectorState
    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 IntercomConnectorState
    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 IntercomConnectorState
    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 IntercomConnectorState
    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.
    The following state arguments are supported:
    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.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Region string
    Regional Hosting - US, EU, or AU. default: US
    Token string
    The Intercom access token.
    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.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Region string
    Regional Hosting - US, EU, or AU. default: US
    Token string
    The Intercom access token.
    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.
    region string
    Regional Hosting - US, EU, or AU. default: US
    token string
    The Intercom access token.
    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.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region String
    Regional Hosting - US, EU, or AU. default: US
    token String
    The Intercom access token.
    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.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region string
    Regional Hosting - US, EU, or AU. default: US
    token string
    The Intercom access token.
    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.
    region str
    Regional Hosting - US, EU, or AU. default: US
    token str
    The Intercom access token.
    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.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region String
    Regional Hosting - US, EU, or AU. default: US
    token String
    The Intercom access token.

    Package Details

    Repository
    descope descope/pulumi-descope
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial