1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. PendoConnector
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 Pendo connector and its configuration in a Descope project. Stream authentication audit logs with the Pendo connector.

    Create PendoConnector Resource

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

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args PendoConnectorArgs
    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 PendoConnectorArgs
    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 PendoConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PendoConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PendoConnectorArgs
    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 pendoConnectorResource = new Descope.PendoConnector("pendoConnectorResource", new()
    {
        BaseUrl = "string",
        ProjectId = "string",
        AuditEnabled = false,
        AuditFilters = new[]
        {
            new Descope.Inputs.PendoConnectorAuditFilterArgs
            {
                Key = "string",
                Operator = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        Description = "string",
        Disabled = false,
        IntegrationKey = "string",
        MaskPii = false,
        Name = "string",
        TroubleshootLogEnabled = false,
    });
    
    example, err := descope.NewPendoConnector(ctx, "pendoConnectorResource", &descope.PendoConnectorArgs{
    	BaseUrl:      pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	AuditEnabled: pulumi.Bool(false),
    	AuditFilters: descope.PendoConnectorAuditFilterArray{
    		&descope.PendoConnectorAuditFilterArgs{
    			Key:      pulumi.String("string"),
    			Operator: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Description:            pulumi.String("string"),
    	Disabled:               pulumi.Bool(false),
    	IntegrationKey:         pulumi.String("string"),
    	MaskPii:                pulumi.Bool(false),
    	Name:                   pulumi.String("string"),
    	TroubleshootLogEnabled: pulumi.Bool(false),
    })
    
    resource "descope_pendo_connector" "pendoConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      base_url      = "string"
      project_id    = "string"
      audit_enabled = false
      audit_filters {
        key      = "string"
        operator = "string"
        values   = ["string"]
      }
      description              = "string"
      disabled                 = false
      integration_key          = "string"
      mask_pii                 = false
      name                     = "string"
      troubleshoot_log_enabled = false
    }
    
    var pendoConnectorResource = new PendoConnector("pendoConnectorResource", PendoConnectorArgs.builder()
        .baseUrl("string")
        .projectId("string")
        .auditEnabled(false)
        .auditFilters(PendoConnectorAuditFilterArgs.builder()
            .key("string")
            .operator("string")
            .values("string")
            .build())
        .description("string")
        .disabled(false)
        .integrationKey("string")
        .maskPii(false)
        .name("string")
        .troubleshootLogEnabled(false)
        .build());
    
    pendo_connector_resource = descope.PendoConnector("pendoConnectorResource",
        base_url="string",
        project_id="string",
        audit_enabled=False,
        audit_filters=[{
            "key": "string",
            "operator": "string",
            "values": ["string"],
        }],
        description="string",
        disabled=False,
        integration_key="string",
        mask_pii=False,
        name="string",
        troubleshoot_log_enabled=False)
    
    const pendoConnectorResource = new descope.PendoConnector("pendoConnectorResource", {
        baseUrl: "string",
        projectId: "string",
        auditEnabled: false,
        auditFilters: [{
            key: "string",
            operator: "string",
            values: ["string"],
        }],
        description: "string",
        disabled: false,
        integrationKey: "string",
        maskPii: false,
        name: "string",
        troubleshootLogEnabled: false,
    });
    
    type: descope:PendoConnector
    properties:
        auditEnabled: false
        auditFilters:
            - key: string
              operator: string
              values:
                - string
        baseUrl: string
        description: string
        disabled: false
        integrationKey: string
        maskPii: false
        name: string
        projectId: string
        troubleshootLogEnabled: false
    

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

    BaseUrl string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.PendoConnectorAuditFilter>
    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.
    IntegrationKey string
    The secret Pendo integration key Descope should use.
    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.
    BaseUrl string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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 []PendoConnectorAuditFilterArgs
    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.
    IntegrationKey string
    The secret Pendo integration key Descope should use.
    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.
    base_url string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    integration_key string
    The secret Pendo integration key Descope should use.
    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.
    baseUrl String
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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<PendoConnectorAuditFilter>
    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.
    integrationKey String
    The secret Pendo integration key Descope should use.
    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.
    baseUrl string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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 PendoConnectorAuditFilter[]
    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.
    integrationKey string
    The secret Pendo integration key Descope should use.
    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.
    base_url str
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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[PendoConnectorAuditFilterArgs]
    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.
    integration_key str
    The secret Pendo integration key Descope should use.
    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.
    baseUrl String
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    integrationKey String
    The secret Pendo integration key Descope should use.
    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 PendoConnector 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 PendoConnector Resource

    Get an existing PendoConnector 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?: PendoConnectorState, opts?: CustomResourceOptions): PendoConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            audit_enabled: Optional[bool] = None,
            audit_filters: Optional[Sequence[PendoConnectorAuditFilterArgs]] = None,
            base_url: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            integration_key: Optional[str] = None,
            mask_pii: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            troubleshoot_log_enabled: Optional[bool] = None) -> PendoConnector
    func GetPendoConnector(ctx *Context, name string, id IDInput, state *PendoConnectorState, opts ...ResourceOption) (*PendoConnector, error)
    public static PendoConnector Get(string name, Input<string> id, PendoConnectorState? state, CustomResourceOptions? opts = null)
    public static PendoConnector get(String name, Output<String> id, PendoConnectorState state, CustomResourceOptions options)
    resources:  existingPendoConnector:    type: descope:PendoConnector    get:      id: ${id}
    import {
      to = descope_pendo_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 PendoConnectorState
    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 PendoConnectorState
    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 PendoConnectorState
    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 PendoConnectorState
    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.PendoConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    BaseUrl string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    IntegrationKey string
    The secret Pendo integration key Descope should use.
    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 []PendoConnectorAuditFilterArgs
    Specify which events will be sent to the external audit service (including tenant selection).
    BaseUrl string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    IntegrationKey string
    The secret Pendo integration key Descope should use.
    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).
    base_url string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    integration_key string
    The secret Pendo integration key Descope should use.
    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<PendoConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    baseUrl String
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    integrationKey String
    The secret Pendo integration key Descope should use.
    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 PendoConnectorAuditFilter[]
    Specify which events will be sent to the external audit service (including tenant selection).
    baseUrl string
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    integrationKey string
    The secret Pendo integration key Descope should use.
    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[PendoConnectorAuditFilterArgs]
    Specify which events will be sent to the external audit service (including tenant selection).
    base_url str
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    integration_key str
    The secret Pendo integration key Descope should use.
    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).
    baseUrl String
    The Pendo regional domain to send logs to. Default is the US region, https://data.pendo.io. Customers in other regions must set this accordingly.
    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.
    integrationKey String
    The secret Pendo integration key Descope should use.
    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

    PendoConnectorAuditFilter, PendoConnectorAuditFilterArgs

    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