Skip to content

GitHubIntegrationInput

Source code in docs_src/capo_securityagent/types/git_hub_integration_input.py 
15
16
17
18
19
20
21
22
23
24
25
class GitHubIntegrationInput(TypedDict, closed=True):
    code: "capo_securityagent.types.auth_code.AuthCode"
    """<p>The OAuth authorization code received from GitHub.</p>"""
    state: "capo_securityagent.types.csrf_state.CsrfState"
    """<p>The CSRF state token for validating the OAuth flow.</p>"""
    organization_name: NotRequired["str"]
    """<p>The name of the GitHub organization to integrate with.</p>"""
    target_url: NotRequired["capo_securityagent.types.target_url.TargetUrl"]
    """<p>The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com.</p>"""
    installation_id: NotRequired["str"]
    """<p>The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com.</p>"""

code instance-attribute 

code: AuthCode

The OAuth authorization code received from GitHub.

installation_id instance-attribute 

installation_id: NotRequired[str]

The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com.

organization_name instance-attribute 

organization_name: NotRequired[str]

The name of the GitHub organization to integrate with.

state instance-attribute 

state: CsrfState

The CSRF state token for validating the OAuth flow.

target_url instance-attribute 

target_url: NotRequired[TargetUrl]

The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com.