1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. MparticleConnector
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 mParticle connector and its configuration in a Descope project. Track and send user event data (e.g. page views, purchases, etc.) across connected tools using the mParticle connector.

    Create MparticleConnector Resource

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

    Constructor syntax

    new MparticleConnector(name: string, args: MparticleConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def MparticleConnector(resource_name: str,
                           args: MparticleConnectorArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def MparticleConnector(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           api_key: Optional[str] = None,
                           api_secret: Optional[str] = None,
                           project_id: Optional[str] = None,
                           base_url: Optional[str] = None,
                           default_environment: Optional[str] = None,
                           description: Optional[str] = None,
                           disabled: Optional[bool] = None,
                           name: Optional[str] = None,
                           use_static_ips: Optional[bool] = None)
    func NewMparticleConnector(ctx *Context, name string, args MparticleConnectorArgs, opts ...ResourceOption) (*MparticleConnector, error)
    public MparticleConnector(string name, MparticleConnectorArgs args, CustomResourceOptions? opts = null)
    public MparticleConnector(String name, MparticleConnectorArgs args)
    public MparticleConnector(String name, MparticleConnectorArgs args, CustomResourceOptions options)
    
    type: descope:MparticleConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_mparticle_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MparticleConnectorArgs
    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 MparticleConnectorArgs
    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 MparticleConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MparticleConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MparticleConnectorArgs
    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 mparticleConnectorResource = new Descope.MparticleConnector("mparticleConnectorResource", new()
    {
        ApiKey = "string",
        ApiSecret = "string",
        ProjectId = "string",
        BaseUrl = "string",
        DefaultEnvironment = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
        UseStaticIps = false,
    });
    
    example, err := descope.NewMparticleConnector(ctx, "mparticleConnectorResource", &descope.MparticleConnectorArgs{
    	ApiKey:             pulumi.String("string"),
    	ApiSecret:          pulumi.String("string"),
    	ProjectId:          pulumi.String("string"),
    	BaseUrl:            pulumi.String("string"),
    	DefaultEnvironment: pulumi.String("string"),
    	Description:        pulumi.String("string"),
    	Disabled:           pulumi.Bool(false),
    	Name:               pulumi.String("string"),
    	UseStaticIps:       pulumi.Bool(false),
    })
    
    resource "descope_mparticle_connector" "mparticleConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      api_key             = "string"
      api_secret          = "string"
      project_id          = "string"
      base_url            = "string"
      default_environment = "string"
      description         = "string"
      disabled            = false
      name                = "string"
      use_static_ips      = false
    }
    
    var mparticleConnectorResource = new MparticleConnector("mparticleConnectorResource", MparticleConnectorArgs.builder()
        .apiKey("string")
        .apiSecret("string")
        .projectId("string")
        .baseUrl("string")
        .defaultEnvironment("string")
        .description("string")
        .disabled(false)
        .name("string")
        .useStaticIps(false)
        .build());
    
    mparticle_connector_resource = descope.MparticleConnector("mparticleConnectorResource",
        api_key="string",
        api_secret="string",
        project_id="string",
        base_url="string",
        default_environment="string",
        description="string",
        disabled=False,
        name="string",
        use_static_ips=False)
    
    const mparticleConnectorResource = new descope.MparticleConnector("mparticleConnectorResource", {
        apiKey: "string",
        apiSecret: "string",
        projectId: "string",
        baseUrl: "string",
        defaultEnvironment: "string",
        description: "string",
        disabled: false,
        name: "string",
        useStaticIps: false,
    });
    
    type: descope:MparticleConnector
    properties:
        apiKey: string
        apiSecret: string
        baseUrl: string
        defaultEnvironment: string
        description: string
        disabled: false
        name: string
        projectId: string
        useStaticIps: false
    

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

    ApiKey string
    The mParticle Server to Server Key generated for the Descope service.
    ApiSecret string
    The mParticle Server to Server Secret generated for the Descope service.
    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.
    BaseUrl string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    DefaultEnvironment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    ApiKey string
    The mParticle Server to Server Key generated for the Descope service.
    ApiSecret string
    The mParticle Server to Server Secret generated for the Descope service.
    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.
    BaseUrl string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    DefaultEnvironment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    api_key string
    The mParticle Server to Server Key generated for the Descope service.
    api_secret string
    The mParticle Server to Server Secret generated for the Descope service.
    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.
    base_url string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    default_environment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The mParticle Server to Server Key generated for the Descope service.
    apiSecret String
    The mParticle Server to Server Secret generated for the Descope service.
    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.
    baseUrl String
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    defaultEnvironment String
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    apiKey string
    The mParticle Server to Server Key generated for the Descope service.
    apiSecret string
    The mParticle Server to Server Secret generated for the Descope service.
    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.
    baseUrl string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    defaultEnvironment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    useStaticIps boolean
    Whether the connector should send all requests from specific static IPs.
    api_key str
    The mParticle Server to Server Key generated for the Descope service.
    api_secret str
    The mParticle Server to Server Secret generated for the Descope service.
    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.
    base_url str
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    default_environment str
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The mParticle Server to Server Key generated for the Descope service.
    apiSecret String
    The mParticle Server to Server Secret generated for the Descope service.
    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.
    baseUrl String
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    defaultEnvironment String
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.

    Outputs

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

    Get an existing MparticleConnector 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?: MparticleConnectorState, opts?: CustomResourceOptions): MparticleConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            api_secret: Optional[str] = None,
            base_url: Optional[str] = None,
            default_environment: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            use_static_ips: Optional[bool] = None) -> MparticleConnector
    func GetMparticleConnector(ctx *Context, name string, id IDInput, state *MparticleConnectorState, opts ...ResourceOption) (*MparticleConnector, error)
    public static MparticleConnector Get(string name, Input<string> id, MparticleConnectorState? state, CustomResourceOptions? opts = null)
    public static MparticleConnector get(String name, Output<String> id, MparticleConnectorState state, CustomResourceOptions options)
    resources:  existingMparticleConnector:    type: descope:MparticleConnector    get:      id: ${id}
    import {
      to = descope_mparticle_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 MparticleConnectorState
    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 MparticleConnectorState
    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 MparticleConnectorState
    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 MparticleConnectorState
    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:
    ApiKey string
    The mParticle Server to Server Key generated for the Descope service.
    ApiSecret string
    The mParticle Server to Server Secret generated for the Descope service.
    BaseUrl string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    DefaultEnvironment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    ApiKey string
    The mParticle Server to Server Key generated for the Descope service.
    ApiSecret string
    The mParticle Server to Server Secret generated for the Descope service.
    BaseUrl string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    DefaultEnvironment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    api_key string
    The mParticle Server to Server Key generated for the Descope service.
    api_secret string
    The mParticle Server to Server Secret generated for the Descope service.
    base_url string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    default_environment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The mParticle Server to Server Key generated for the Descope service.
    apiSecret String
    The mParticle Server to Server Secret generated for the Descope service.
    baseUrl String
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    defaultEnvironment String
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    apiKey string
    The mParticle Server to Server Key generated for the Descope service.
    apiSecret string
    The mParticle Server to Server Secret generated for the Descope service.
    baseUrl string
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    defaultEnvironment string
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    useStaticIps boolean
    Whether the connector should send all requests from specific static IPs.
    api_key str
    The mParticle Server to Server Key generated for the Descope service.
    api_secret str
    The mParticle Server to Server Secret generated for the Descope service.
    base_url str
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    default_environment str
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The mParticle Server to Server Key generated for the Descope service.
    apiSecret String
    The mParticle Server to Server Secret generated for the Descope service.
    baseUrl String
    The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
    defaultEnvironment String
    The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
    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.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.

    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