published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a groundcover connector and its configuration in a Descope project. Send audit events and troubleshooting logs to groundcover.
Create GroundcoverConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GroundcoverConnector(name: string, args: GroundcoverConnectorArgs, opts?: CustomResourceOptions);@overload
def GroundcoverConnector(resource_name: str,
args: GroundcoverConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GroundcoverConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
endpoint: Optional[str] = None,
ingestion_key: Optional[str] = None,
project_id: Optional[str] = None,
audit_enabled: Optional[bool] = None,
audit_filters: Optional[Sequence[GroundcoverConnectorAuditFilterArgs]] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
environment_name: Optional[str] = None,
mask_pii: Optional[bool] = None,
name: Optional[str] = None,
service_name: Optional[str] = None,
troubleshoot_log_enabled: Optional[bool] = None)func NewGroundcoverConnector(ctx *Context, name string, args GroundcoverConnectorArgs, opts ...ResourceOption) (*GroundcoverConnector, error)public GroundcoverConnector(string name, GroundcoverConnectorArgs args, CustomResourceOptions? opts = null)
public GroundcoverConnector(String name, GroundcoverConnectorArgs args)
public GroundcoverConnector(String name, GroundcoverConnectorArgs args, CustomResourceOptions options)
type: descope:GroundcoverConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_groundcover_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GroundcoverConnectorArgs
- 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 GroundcoverConnectorArgs
- 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 GroundcoverConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroundcoverConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroundcoverConnectorArgs
- 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 groundcoverConnectorResource = new Descope.GroundcoverConnector("groundcoverConnectorResource", new()
{
Endpoint = "string",
IngestionKey = "string",
ProjectId = "string",
AuditEnabled = false,
AuditFilters = new[]
{
new Descope.Inputs.GroundcoverConnectorAuditFilterArgs
{
Key = "string",
Operator = "string",
Values = new[]
{
"string",
},
},
},
Description = "string",
Disabled = false,
EnvironmentName = "string",
MaskPii = false,
Name = "string",
ServiceName = "string",
TroubleshootLogEnabled = false,
});
example, err := descope.NewGroundcoverConnector(ctx, "groundcoverConnectorResource", &descope.GroundcoverConnectorArgs{
Endpoint: pulumi.String("string"),
IngestionKey: pulumi.String("string"),
ProjectId: pulumi.String("string"),
AuditEnabled: pulumi.Bool(false),
AuditFilters: descope.GroundcoverConnectorAuditFilterArray{
&descope.GroundcoverConnectorAuditFilterArgs{
Key: pulumi.String("string"),
Operator: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
EnvironmentName: pulumi.String("string"),
MaskPii: pulumi.Bool(false),
Name: pulumi.String("string"),
ServiceName: pulumi.String("string"),
TroubleshootLogEnabled: pulumi.Bool(false),
})
resource "descope_groundcover_connector" "groundcoverConnectorResource" {
lifecycle {
create_before_destroy = true
}
endpoint = "string"
ingestion_key = "string"
project_id = "string"
audit_enabled = false
audit_filters {
key = "string"
operator = "string"
values = ["string"]
}
description = "string"
disabled = false
environment_name = "string"
mask_pii = false
name = "string"
service_name = "string"
troubleshoot_log_enabled = false
}
var groundcoverConnectorResource = new GroundcoverConnector("groundcoverConnectorResource", GroundcoverConnectorArgs.builder()
.endpoint("string")
.ingestionKey("string")
.projectId("string")
.auditEnabled(false)
.auditFilters(GroundcoverConnectorAuditFilterArgs.builder()
.key("string")
.operator("string")
.values("string")
.build())
.description("string")
.disabled(false)
.environmentName("string")
.maskPii(false)
.name("string")
.serviceName("string")
.troubleshootLogEnabled(false)
.build());
groundcover_connector_resource = descope.GroundcoverConnector("groundcoverConnectorResource",
endpoint="string",
ingestion_key="string",
project_id="string",
audit_enabled=False,
audit_filters=[{
"key": "string",
"operator": "string",
"values": ["string"],
}],
description="string",
disabled=False,
environment_name="string",
mask_pii=False,
name="string",
service_name="string",
troubleshoot_log_enabled=False)
const groundcoverConnectorResource = new descope.GroundcoverConnector("groundcoverConnectorResource", {
endpoint: "string",
ingestionKey: "string",
projectId: "string",
auditEnabled: false,
auditFilters: [{
key: "string",
operator: "string",
values: ["string"],
}],
description: "string",
disabled: false,
environmentName: "string",
maskPii: false,
name: "string",
serviceName: "string",
troubleshootLogEnabled: false,
});
type: descope:GroundcoverConnector
properties:
auditEnabled: false
auditFilters:
- key: string
operator: string
values:
- string
description: string
disabled: false
endpoint: string
environmentName: string
ingestionKey: string
maskPii: false
name: string
projectId: string
serviceName: string
troubleshootLogEnabled: false
GroundcoverConnector 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 GroundcoverConnector resource accepts the following input properties:
- Endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- Ingestion
Key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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<Descope.Groundcover Connector Audit Filter> - 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.
- Environment
Name string - Name of the environment tag.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Name string
- A custom name for your connector.
- Service
Name string - Name of the service tag.
- Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- Endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- Ingestion
Key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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 []GroundcoverConnector Audit Filter Args - 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.
- Environment
Name string - Name of the environment tag.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Name string
- A custom name for your connector.
- Service
Name string - Name of the service tag.
- Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- ingestion_
key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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.
- environment_
name string - Name of the environment tag.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- name string
- A custom name for your connector.
- service_
name string - Name of the service tag.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- endpoint String
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- ingestion
Key String - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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 Boolean - Whether to enable streaming of audit events.
- audit
Filters List<GroundcoverConnector Audit Filter> - 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.
- environment
Name String - Name of the environment tag.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- name String
- A custom name for your connector.
- service
Name String - Name of the service tag.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
- endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- ingestion
Key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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 boolean - Whether to enable streaming of audit events.
- audit
Filters GroundcoverConnector Audit Filter[] - 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.
- environment
Name string - Name of the environment tag.
- mask
Pii boolean - Whether to mask personally identifiable information in the logs.
- name string
- A custom name for your connector.
- service
Name string - Name of the service tag.
- troubleshoot
Log booleanEnabled - Whether to send troubleshooting events.
- endpoint str
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- ingestion_
key str - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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[GroundcoverConnector Audit Filter Args] - 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.
- environment_
name str - Name of the environment tag.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- name str
- A custom name for your connector.
- service_
name str - Name of the service tag.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- endpoint String
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- ingestion
Key String - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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 Boolean - Whether to enable streaming of audit events.
- audit
Filters 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.
- environment
Name String - Name of the environment tag.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- name String
- A custom name for your connector.
- service
Name String - Name of the service tag.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
Outputs
All input properties are implicitly available as output properties. Additionally, the GroundcoverConnector 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 GroundcoverConnector Resource
Get an existing GroundcoverConnector 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?: GroundcoverConnectorState, opts?: CustomResourceOptions): GroundcoverConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
audit_enabled: Optional[bool] = None,
audit_filters: Optional[Sequence[GroundcoverConnectorAuditFilterArgs]] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
endpoint: Optional[str] = None,
environment_name: Optional[str] = None,
ingestion_key: Optional[str] = None,
mask_pii: Optional[bool] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
service_name: Optional[str] = None,
troubleshoot_log_enabled: Optional[bool] = None) -> GroundcoverConnectorfunc GetGroundcoverConnector(ctx *Context, name string, id IDInput, state *GroundcoverConnectorState, opts ...ResourceOption) (*GroundcoverConnector, error)public static GroundcoverConnector Get(string name, Input<string> id, GroundcoverConnectorState? state, CustomResourceOptions? opts = null)public static GroundcoverConnector get(String name, Output<String> id, GroundcoverConnectorState state, CustomResourceOptions options)resources: existingGroundcoverConnector: type: descope:GroundcoverConnector get: id: ${id}import {
to = descope_groundcover_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 GroundcoverConnectorState
- 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 GroundcoverConnectorState
- 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 GroundcoverConnectorState
- 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 GroundcoverConnectorState
- 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.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters List<Descope.Groundcover Connector Audit Filter> - 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.
- Endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- Environment
Name string - Name of the environment tag.
- Ingestion
Key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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.
- Service
Name string - Name of the service tag.
- Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters []GroundcoverConnector Audit Filter Args - 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.
- Endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- Environment
Name string - Name of the environment tag.
- Ingestion
Key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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.
- Service
Name string - Name of the service tag.
- Troubleshoot
Log boolEnabled - 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.
- endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- environment_
name string - Name of the environment tag.
- ingestion_
key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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.
- service_
name string - Name of the service tag.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<GroundcoverConnector Audit Filter> - 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.
- endpoint String
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- environment
Name String - Name of the environment tag.
- ingestion
Key String - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- mask
Pii Boolean - 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.
- service
Name String - Name of the service tag.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
- audit
Enabled boolean - Whether to enable streaming of audit events.
- audit
Filters GroundcoverConnector Audit Filter[] - 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.
- endpoint string
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- environment
Name string - Name of the environment tag.
- ingestion
Key string - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- mask
Pii boolean - 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.
- service
Name string - Name of the service tag.
- troubleshoot
Log booleanEnabled - Whether to send troubleshooting events.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters Sequence[GroundcoverConnector Audit Filter Args] - 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.
- endpoint str
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- environment_
name str - Name of the environment tag.
- ingestion_
key str - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- 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.
- service_
name str - Name of the service tag.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters 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.
- endpoint String
- The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
- environment
Name String - Name of the environment tag.
- ingestion
Key String - Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
- mask
Pii Boolean - 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.
- service
Name String - Name of the service tag.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
Supporting Types
GroundcoverConnectorAuditFilter, GroundcoverConnectorAuditFilterArgs
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope