Skip to content

OAuthConfig

Source code in docs_src/capo_iot_managed_integrations/types/o_auth_config.py
class OAuthConfig(TypedDict, closed=True):
    auth_url: "capo_iot_managed_integrations.types.auth_url.AuthUrl"
    """<p>The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.</p>"""
    token_url: "capo_iot_managed_integrations.types.token_url.TokenUrl"
    """<p>The token URL for the OAuth service, where authorization codes are exchanged for access tokens.</p>"""
    scope: NotRequired["str"]
    """<p>The OAuth scopes requested during authorization, which define the permissions granted to the application.</p>"""
    token_endpoint_authentication_scheme: "capo_iot_managed_integrations.types.token_endpoint_authentication_scheme.TokenEndpointAuthenticationScheme"
    """<p>The authentication scheme used when requesting tokens from the token endpoint.</p>"""
    o_auth_complete_redirect_url: NotRequired["str"]
    """<p>The URL where users are redirected after completing the OAuth authorization process.</p>"""
    proactive_refresh_token_renewal: NotRequired[
        "capo_iot_managed_integrations.types.proactive_refresh_token_renewal.ProactiveRefreshTokenRenewal"
    ]
    """<p>Configuration for proactively refreshing OAuth tokens before they expire.</p>"""

auth_url instance-attribute

auth_url: AuthUrl

The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

o_auth_complete_redirect_url instance-attribute

o_auth_complete_redirect_url: NotRequired[str]

The URL where users are redirected after completing the OAuth authorization process.

proactive_refresh_token_renewal instance-attribute

proactive_refresh_token_renewal: NotRequired[ProactiveRefreshTokenRenewal]

Configuration for proactively refreshing OAuth tokens before they expire.

scope instance-attribute

scope: NotRequired[str]

The OAuth scopes requested during authorization, which define the permissions granted to the application.

token_endpoint_authentication_scheme instance-attribute

token_endpoint_authentication_scheme: TokenEndpointAuthenticationScheme

The authentication scheme used when requesting tokens from the token endpoint.

token_url instance-attribute

token_url: TokenUrl

The token URL for the OAuth service, where authorization codes are exchanged for access tokens.