Skip to content

IntegrationSummary

Source code in docs_src/capo_securityagent/types/integration_summary.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class IntegrationSummary(TypedDict, closed=True):
    integration_id: "str"
    """<p>The unique identifier of the integration.</p>"""
    installation_id: "str"
    """<p>The installation identifier from the integration provider.</p>"""
    provider: "capo_securityagent.types.provider.Provider"
    """<p>The integration provider.</p>"""
    provider_type: "capo_securityagent.types.provider_type.ProviderType"
    """<p>The type of the integration provider.</p>"""
    display_name: "str"
    """<p>The display name of the integration.</p>"""
    target_url: NotRequired["capo_securityagent.types.target_url.TargetUrl"]
    """<p>The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.</p>"""
    webhook_url: NotRequired["str"]
    """<p>The payload URL of the integration's webhook, once it has been created. The signing secret is never returned on a read.</p>"""
    private_connection_name: NotRequired[
        "capo_securityagent.types.private_connection_name.PrivateConnectionName"
    ]
    """<p>The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.</p>"""

display_name instance-attribute 

display_name: str

The display name of the integration.

installation_id instance-attribute 

installation_id: str

The installation identifier from the integration provider.

integration_id instance-attribute 

integration_id: str

The unique identifier of the integration.

private_connection_name instance-attribute 

private_connection_name: NotRequired[PrivateConnectionName]

The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.

provider instance-attribute 

provider: Provider

The integration provider.

provider_type instance-attribute 

provider_type: ProviderType

The type of the integration provider.

target_url instance-attribute 

target_url: NotRequired[TargetUrl]

The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.

webhook_url instance-attribute 

webhook_url: NotRequired[str]

The payload URL of the integration's webhook, once it has been created. The signing secret is never returned on a read.