Skip to content

GitHubAuthorizationConfiguration

Source code in docs_src/capo_continuum/types/git_hub_authorization_configuration.py
class GitHubAuthorizationConfiguration(TypedDict, closed=True):
    authorization_code: "capo_continuum.types.authorization_code.AuthorizationCode"
    """The OAuth authorization code returned by GitHub after the user authorizes the application."""
    state: "capo_continuum.types.o_auth_state.OAuthState"
    """The `state` returned by GitHub in the OAuth callback. It must be the state that StartIntegrationAuthorization returned to the same AWS account, and the authorization request must have sent that call's codeChallenge. The state can be redeemed once. A stage that enforces authorization sessions rejects a missing, expired, already used, or other-account state with ValidationException; restart the authorization with StartIntegrationAuthorization."""
    redirect_url: NotRequired["capo_continuum.types.redirect_url.RedirectUrl"]
    """The redirect URL used to obtain the authorization code. Must match one of the redirect URLs registered on the GitHub App. If omitted, the App's default redirect URL is used. Not stored or returned after creation."""

authorization_code instance-attribute

authorization_code: AuthorizationCode

The OAuth authorization code returned by GitHub after the user authorizes the application.

redirect_url instance-attribute

redirect_url: NotRequired[RedirectUrl]

The redirect URL used to obtain the authorization code. Must match one of the redirect URLs registered on the GitHub App. If omitted, the App's default redirect URL is used. Not stored or returned after creation.

state instance-attribute

state: OAuthState

The state returned by GitHub in the OAuth callback. It must be the state that StartIntegrationAuthorization returned to the same AWS account, and the authorization request must have sent that call's codeChallenge. The state can be redeemed once. A stage that enforces authorization sessions rejects a missing, expired, already used, or other-account state with ValidationException; restart the authorization with StartIntegrationAuthorization.