1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. SplunkConnector
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 Splunk connector and its configuration in a Descope project. Stream logs and audit events with the Splunk HTTP Event Collector (HEC).

    Create SplunkConnector Resource

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

    Constructor syntax

    new SplunkConnector(name: string, args: SplunkConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def SplunkConnector(resource_name: str,
                        args: SplunkConnectorArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def SplunkConnector(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        hec_token: Optional[str] = None,
                        hec_url: Optional[str] = None,
                        project_id: Optional[str] = None,
                        audit_enabled: Optional[bool] = None,
                        audit_filters: Optional[Sequence[SplunkConnectorAuditFilterArgs]] = None,
                        description: Optional[str] = None,
                        disabled: Optional[bool] = None,
                        index: Optional[str] = None,
                        name: Optional[str] = None,
                        troubleshoot_log_enabled: Optional[bool] = None)
    func NewSplunkConnector(ctx *Context, name string, args SplunkConnectorArgs, opts ...ResourceOption) (*SplunkConnector, error)
    public SplunkConnector(string name, SplunkConnectorArgs args, CustomResourceOptions? opts = null)
    public SplunkConnector(String name, SplunkConnectorArgs args)
    public SplunkConnector(String name, SplunkConnectorArgs args, CustomResourceOptions options)
    
    type: descope:SplunkConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_splunk_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SplunkConnectorArgs
    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 SplunkConnectorArgs
    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 SplunkConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SplunkConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SplunkConnectorArgs
    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 splunkConnectorResource = new Descope.SplunkConnector("splunkConnectorResource", new()
    {
        HecToken = "string",
        HecUrl = "string",
        ProjectId = "string",
        AuditEnabled = false,
        AuditFilters = new[]
        {
            new Descope.Inputs.SplunkConnectorAuditFilterArgs
            {
                Key = "string",
                Operator = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        Description = "string",
        Disabled = false,
        Index = "string",
        Name = "string",
        TroubleshootLogEnabled = false,
    });
    
    example, err := descope.NewSplunkConnector(ctx, "splunkConnectorResource", &descope.SplunkConnectorArgs{
    	HecToken:     pulumi.String("string"),
    	HecUrl:       pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	AuditEnabled: pulumi.Bool(false),
    	AuditFilters: descope.SplunkConnectorAuditFilterArray{
    		&descope.SplunkConnectorAuditFilterArgs{
    			Key:      pulumi.String("string"),
    			Operator: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Description:            pulumi.String("string"),
    	Disabled:               pulumi.Bool(false),
    	Index:                  pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	TroubleshootLogEnabled: pulumi.Bool(false),
    })
    
    resource "descope_splunk_connector" "splunkConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      hec_token     = "string"
      hec_url       = "string"
      project_id    = "string"
      audit_enabled = false
      audit_filters {
        key      = "string"
        operator = "string"
        values   = ["string"]
      }
      description              = "string"
      disabled                 = false
      index                    = "string"
      name                     = "string"
      troubleshoot_log_enabled = false
    }
    
    var splunkConnectorResource = new SplunkConnector("splunkConnectorResource", SplunkConnectorArgs.builder()
        .hecToken("string")
        .hecUrl("string")
        .projectId("string")
        .auditEnabled(false)
        .auditFilters(SplunkConnectorAuditFilterArgs.builder()
            .key("string")
            .operator("string")
            .values("string")
            .build())
        .description("string")
        .disabled(false)
        .index("string")
        .name("string")
        .troubleshootLogEnabled(false)
        .build());
    
    splunk_connector_resource = descope.SplunkConnector("splunkConnectorResource",
        hec_token="string",
        hec_url="string",
        project_id="string",
        audit_enabled=False,
        audit_filters=[{
            "key": "string",
            "operator": "string",
            "values": ["string"],
        }],
        description="string",
        disabled=False,
        index="string",
        name="string",
        troubleshoot_log_enabled=False)
    
    const splunkConnectorResource = new descope.SplunkConnector("splunkConnectorResource", {
        hecToken: "string",
        hecUrl: "string",
        projectId: "string",
        auditEnabled: false,
        auditFilters: [{
            key: "string",
            operator: "string",
            values: ["string"],
        }],
        description: "string",
        disabled: false,
        index: "string",
        name: "string",
        troubleshootLogEnabled: false,
    });
    
    type: descope:SplunkConnector
    properties:
        auditEnabled: false
        auditFilters:
            - key: string
              operator: string
              values:
                - string
        description: string
        disabled: false
        hecToken: string
        hecUrl: string
        index: string
        name: string
        projectId: string
        troubleshootLogEnabled: false
    

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

    HecToken string
    An HTTP Event Collector token configured on your Splunk project.
    HecUrl string
    The URL to be used accessing your Splunk system, including the appropriate port
    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.
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters List<Descope.SplunkConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    Index string
    An optional index to use for all sent events
    Name string
    A custom name for your connector.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    HecToken string
    An HTTP Event Collector token configured on your Splunk project.
    HecUrl string
    The URL to be used accessing your Splunk system, including the appropriate port
    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.
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters []SplunkConnectorAuditFilterArgs
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    Index string
    An optional index to use for all sent events
    Name string
    A custom name for your connector.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    hec_token string
    An HTTP Event Collector token configured on your Splunk project.
    hec_url string
    The URL to be used accessing your Splunk system, including the appropriate port
    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.
    audit_enabled bool
    Whether to enable streaming of audit events.
    audit_filters list(object)
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    index string
    An optional index to use for all sent events
    name string
    A custom name for your connector.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    hecToken String
    An HTTP Event Collector token configured on your Splunk project.
    hecUrl String
    The URL to be used accessing your Splunk system, including the appropriate port
    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.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<SplunkConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    index String
    An optional index to use for all sent events
    name String
    A custom name for your connector.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.
    hecToken string
    An HTTP Event Collector token configured on your Splunk project.
    hecUrl string
    The URL to be used accessing your Splunk system, including the appropriate port
    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.
    auditEnabled boolean
    Whether to enable streaming of audit events.
    auditFilters SplunkConnectorAuditFilter[]
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    index string
    An optional index to use for all sent events
    name string
    A custom name for your connector.
    troubleshootLogEnabled boolean
    Whether to send troubleshooting events.
    hec_token str
    An HTTP Event Collector token configured on your Splunk project.
    hec_url str
    The URL to be used accessing your Splunk system, including the appropriate port
    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.
    audit_enabled bool
    Whether to enable streaming of audit events.
    audit_filters Sequence[SplunkConnectorAuditFilterArgs]
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    index str
    An optional index to use for all sent events
    name str
    A custom name for your connector.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    hecToken String
    An HTTP Event Collector token configured on your Splunk project.
    hecUrl String
    The URL to be used accessing your Splunk system, including the appropriate port
    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.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<Property Map>
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    index String
    An optional index to use for all sent events
    name String
    A custom name for your connector.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.

    Outputs

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

    Get an existing SplunkConnector 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?: SplunkConnectorState, opts?: CustomResourceOptions): SplunkConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            audit_enabled: Optional[bool] = None,
            audit_filters: Optional[Sequence[SplunkConnectorAuditFilterArgs]] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            hec_token: Optional[str] = None,
            hec_url: Optional[str] = None,
            index: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            troubleshoot_log_enabled: Optional[bool] = None) -> SplunkConnector
    func GetSplunkConnector(ctx *Context, name string, id IDInput, state *SplunkConnectorState, opts ...ResourceOption) (*SplunkConnector, error)
    public static SplunkConnector Get(string name, Input<string> id, SplunkConnectorState? state, CustomResourceOptions? opts = null)
    public static SplunkConnector get(String name, Output<String> id, SplunkConnectorState state, CustomResourceOptions options)
    resources:  existingSplunkConnector:    type: descope:SplunkConnector    get:      id: ${id}
    import {
      to = descope_splunk_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 SplunkConnectorState
    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 SplunkConnectorState
    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 SplunkConnectorState
    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 SplunkConnectorState
    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:
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters List<Descope.SplunkConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    HecToken string
    An HTTP Event Collector token configured on your Splunk project.
    HecUrl string
    The URL to be used accessing your Splunk system, including the appropriate port
    Index string
    An optional index to use for all sent events
    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.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters []SplunkConnectorAuditFilterArgs
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    HecToken string
    An HTTP Event Collector token configured on your Splunk project.
    HecUrl string
    The URL to be used accessing your Splunk system, including the appropriate port
    Index string
    An optional index to use for all sent events
    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.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    audit_enabled bool
    Whether to enable streaming of audit events.
    audit_filters list(object)
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    hec_token string
    An HTTP Event Collector token configured on your Splunk project.
    hec_url string
    The URL to be used accessing your Splunk system, including the appropriate port
    index string
    An optional index to use for all sent events
    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.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<SplunkConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    hecToken String
    An HTTP Event Collector token configured on your Splunk project.
    hecUrl String
    The URL to be used accessing your Splunk system, including the appropriate port
    index String
    An optional index to use for all sent events
    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.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.
    auditEnabled boolean
    Whether to enable streaming of audit events.
    auditFilters SplunkConnectorAuditFilter[]
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    hecToken string
    An HTTP Event Collector token configured on your Splunk project.
    hecUrl string
    The URL to be used accessing your Splunk system, including the appropriate port
    index string
    An optional index to use for all sent events
    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.
    troubleshootLogEnabled boolean
    Whether to send troubleshooting events.
    audit_enabled bool
    Whether to enable streaming of audit events.
    audit_filters Sequence[SplunkConnectorAuditFilterArgs]
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    hec_token str
    An HTTP Event Collector token configured on your Splunk project.
    hec_url str
    The URL to be used accessing your Splunk system, including the appropriate port
    index str
    An optional index to use for all sent events
    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.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<Property Map>
    Specify which events will be sent to the external audit service (including tenant selection).
    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.
    hecToken String
    An HTTP Event Collector token configured on your Splunk project.
    hecUrl String
    The URL to be used accessing your Splunk system, including the appropriate port
    index String
    An optional index to use for all sent events
    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.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.

    Supporting Types

    SplunkConnectorAuditFilter, SplunkConnectorAuditFilterArgs

    Key string
    The field name to filter on (either 'actions' or 'tenants').
    Operator string
    The filter operation to apply ('includes' or 'excludes').
    Values List<string>
    The list of values to match against for the filter.
    Key string
    The field name to filter on (either 'actions' or 'tenants').
    Operator string
    The filter operation to apply ('includes' or 'excludes').
    Values []string
    The list of values to match against for the filter.
    key string
    The field name to filter on (either 'actions' or 'tenants').
    operator string
    The filter operation to apply ('includes' or 'excludes').
    values list(string)
    The list of values to match against for the filter.
    key String
    The field name to filter on (either 'actions' or 'tenants').
    operator String
    The filter operation to apply ('includes' or 'excludes').
    values List<String>
    The list of values to match against for the filter.
    key string
    The field name to filter on (either 'actions' or 'tenants').
    operator string
    The filter operation to apply ('includes' or 'excludes').
    values string[]
    The list of values to match against for the filter.
    key str
    The field name to filter on (either 'actions' or 'tenants').
    operator str
    The filter operation to apply ('includes' or 'excludes').
    values Sequence[str]
    The list of values to match against for the filter.
    key String
    The field name to filter on (either 'actions' or 'tenants').
    operator String
    The filter operation to apply ('includes' or 'excludes').
    values List<String>
    The list of values to match against for the filter.

    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