1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. CoralogixConnector
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 Coralogix connector and its configuration in a Descope project. Send audit events and troubleshooting logs to Coralogix.

    Create CoralogixConnector Resource

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

    Constructor syntax

    new CoralogixConnector(name: string, args: CoralogixConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def CoralogixConnector(resource_name: str,
                           args: CoralogixConnectorArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def CoralogixConnector(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           bearer_token: Optional[str] = None,
                           endpoint: Optional[str] = None,
                           project_id: Optional[str] = None,
                           audit_enabled: Optional[bool] = None,
                           audit_filters: Optional[Sequence[CoralogixConnectorAuditFilterArgs]] = None,
                           description: Optional[str] = None,
                           disabled: Optional[bool] = None,
                           mask_pii: Optional[bool] = None,
                           name: Optional[str] = None,
                           troubleshoot_log_enabled: Optional[bool] = None)
    func NewCoralogixConnector(ctx *Context, name string, args CoralogixConnectorArgs, opts ...ResourceOption) (*CoralogixConnector, error)
    public CoralogixConnector(string name, CoralogixConnectorArgs args, CustomResourceOptions? opts = null)
    public CoralogixConnector(String name, CoralogixConnectorArgs args)
    public CoralogixConnector(String name, CoralogixConnectorArgs args, CustomResourceOptions options)
    
    type: descope:CoralogixConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_coralogix_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CoralogixConnectorArgs
    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 CoralogixConnectorArgs
    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 CoralogixConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CoralogixConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CoralogixConnectorArgs
    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 coralogixConnectorResource = new Descope.CoralogixConnector("coralogixConnectorResource", new()
    {
        BearerToken = "string",
        Endpoint = "string",
        ProjectId = "string",
        AuditEnabled = false,
        AuditFilters = new[]
        {
            new Descope.Inputs.CoralogixConnectorAuditFilterArgs
            {
                Key = "string",
                Operator = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        Description = "string",
        Disabled = false,
        MaskPii = false,
        Name = "string",
        TroubleshootLogEnabled = false,
    });
    
    example, err := descope.NewCoralogixConnector(ctx, "coralogixConnectorResource", &descope.CoralogixConnectorArgs{
    	BearerToken:  pulumi.String("string"),
    	Endpoint:     pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	AuditEnabled: pulumi.Bool(false),
    	AuditFilters: descope.CoralogixConnectorAuditFilterArray{
    		&descope.CoralogixConnectorAuditFilterArgs{
    			Key:      pulumi.String("string"),
    			Operator: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Description:            pulumi.String("string"),
    	Disabled:               pulumi.Bool(false),
    	MaskPii:                pulumi.Bool(false),
    	Name:                   pulumi.String("string"),
    	TroubleshootLogEnabled: pulumi.Bool(false),
    })
    
    resource "descope_coralogix_connector" "coralogixConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      bearer_token  = "string"
      endpoint      = "string"
      project_id    = "string"
      audit_enabled = false
      audit_filters {
        key      = "string"
        operator = "string"
        values   = ["string"]
      }
      description              = "string"
      disabled                 = false
      mask_pii                 = false
      name                     = "string"
      troubleshoot_log_enabled = false
    }
    
    var coralogixConnectorResource = new CoralogixConnector("coralogixConnectorResource", CoralogixConnectorArgs.builder()
        .bearerToken("string")
        .endpoint("string")
        .projectId("string")
        .auditEnabled(false)
        .auditFilters(CoralogixConnectorAuditFilterArgs.builder()
            .key("string")
            .operator("string")
            .values("string")
            .build())
        .description("string")
        .disabled(false)
        .maskPii(false)
        .name("string")
        .troubleshootLogEnabled(false)
        .build());
    
    coralogix_connector_resource = descope.CoralogixConnector("coralogixConnectorResource",
        bearer_token="string",
        endpoint="string",
        project_id="string",
        audit_enabled=False,
        audit_filters=[{
            "key": "string",
            "operator": "string",
            "values": ["string"],
        }],
        description="string",
        disabled=False,
        mask_pii=False,
        name="string",
        troubleshoot_log_enabled=False)
    
    const coralogixConnectorResource = new descope.CoralogixConnector("coralogixConnectorResource", {
        bearerToken: "string",
        endpoint: "string",
        projectId: "string",
        auditEnabled: false,
        auditFilters: [{
            key: "string",
            operator: "string",
            values: ["string"],
        }],
        description: "string",
        disabled: false,
        maskPii: false,
        name: "string",
        troubleshootLogEnabled: false,
    });
    
    type: descope:CoralogixConnector
    properties:
        auditEnabled: false
        auditFilters:
            - key: string
              operator: string
              values:
                - string
        bearerToken: string
        description: string
        disabled: false
        endpoint: string
        maskPii: false
        name: string
        projectId: string
        troubleshootLogEnabled: false
    

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

    BearerToken string
    Bearer token issued by Coralogix as Send-Your-Data API key
    Endpoint string
    The ingress OpenTelemetry endpoint URL.
    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.CoralogixConnectorAuditFilter>
    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.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    Name string
    A custom name for your connector.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    BearerToken string
    Bearer token issued by Coralogix as Send-Your-Data API key
    Endpoint string
    The ingress OpenTelemetry endpoint URL.
    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 []CoralogixConnectorAuditFilterArgs
    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.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    Name string
    A custom name for your connector.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    bearer_token string
    Bearer token issued by Coralogix as Send-Your-Data API key
    endpoint string
    The ingress OpenTelemetry endpoint URL.
    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.
    mask_pii bool
    Whether to mask personally identifiable information in the logs.
    name string
    A custom name for your connector.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    bearerToken String
    Bearer token issued by Coralogix as Send-Your-Data API key
    endpoint String
    The ingress OpenTelemetry endpoint URL.
    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<CoralogixConnectorAuditFilter>
    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.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    name String
    A custom name for your connector.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.
    bearerToken string
    Bearer token issued by Coralogix as Send-Your-Data API key
    endpoint string
    The ingress OpenTelemetry endpoint URL.
    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 CoralogixConnectorAuditFilter[]
    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.
    maskPii boolean
    Whether to mask personally identifiable information in the logs.
    name string
    A custom name for your connector.
    troubleshootLogEnabled boolean
    Whether to send troubleshooting events.
    bearer_token str
    Bearer token issued by Coralogix as Send-Your-Data API key
    endpoint str
    The ingress OpenTelemetry endpoint URL.
    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[CoralogixConnectorAuditFilterArgs]
    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.
    mask_pii bool
    Whether to mask personally identifiable information in the logs.
    name str
    A custom name for your connector.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    bearerToken String
    Bearer token issued by Coralogix as Send-Your-Data API key
    endpoint String
    The ingress OpenTelemetry endpoint URL.
    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.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    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 CoralogixConnector 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 CoralogixConnector Resource

    Get an existing CoralogixConnector 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?: CoralogixConnectorState, opts?: CustomResourceOptions): CoralogixConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            audit_enabled: Optional[bool] = None,
            audit_filters: Optional[Sequence[CoralogixConnectorAuditFilterArgs]] = None,
            bearer_token: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            endpoint: Optional[str] = None,
            mask_pii: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            troubleshoot_log_enabled: Optional[bool] = None) -> CoralogixConnector
    func GetCoralogixConnector(ctx *Context, name string, id IDInput, state *CoralogixConnectorState, opts ...ResourceOption) (*CoralogixConnector, error)
    public static CoralogixConnector Get(string name, Input<string> id, CoralogixConnectorState? state, CustomResourceOptions? opts = null)
    public static CoralogixConnector get(String name, Output<String> id, CoralogixConnectorState state, CustomResourceOptions options)
    resources:  existingCoralogixConnector:    type: descope:CoralogixConnector    get:      id: ${id}
    import {
      to = descope_coralogix_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 CoralogixConnectorState
    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 CoralogixConnectorState
    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 CoralogixConnectorState
    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 CoralogixConnectorState
    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.CoralogixConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    BearerToken string
    Bearer token issued by Coralogix as Send-Your-Data API key
    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.
    Endpoint string
    The ingress OpenTelemetry endpoint URL.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    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 []CoralogixConnectorAuditFilterArgs
    Specify which events will be sent to the external audit service (including tenant selection).
    BearerToken string
    Bearer token issued by Coralogix as Send-Your-Data API key
    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.
    Endpoint string
    The ingress OpenTelemetry endpoint URL.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    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).
    bearer_token string
    Bearer token issued by Coralogix as Send-Your-Data API key
    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.
    endpoint string
    The ingress OpenTelemetry endpoint URL.
    mask_pii bool
    Whether to mask personally identifiable information in the logs.
    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<CoralogixConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    bearerToken String
    Bearer token issued by Coralogix as Send-Your-Data API key
    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.
    endpoint String
    The ingress OpenTelemetry endpoint URL.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    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 CoralogixConnectorAuditFilter[]
    Specify which events will be sent to the external audit service (including tenant selection).
    bearerToken string
    Bearer token issued by Coralogix as Send-Your-Data API key
    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.
    endpoint string
    The ingress OpenTelemetry endpoint URL.
    maskPii boolean
    Whether to mask personally identifiable information in the logs.
    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[CoralogixConnectorAuditFilterArgs]
    Specify which events will be sent to the external audit service (including tenant selection).
    bearer_token str
    Bearer token issued by Coralogix as Send-Your-Data API key
    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.
    endpoint str
    The ingress OpenTelemetry endpoint URL.
    mask_pii bool
    Whether to mask personally identifiable information in the logs.
    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).
    bearerToken String
    Bearer token issued by Coralogix as Send-Your-Data API key
    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.
    endpoint String
    The ingress OpenTelemetry endpoint URL.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    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

    CoralogixConnectorAuditFilter, CoralogixConnectorAuditFilterArgs

    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