Skip to content

OAuth2PropertiesInput

Source code in docs_src/capo_glue/types/o_auth2_properties_input.py
class OAuth2PropertiesInput(TypedDict, closed=True):
    o_auth2_grant_type: NotRequired[
        "capo_glue.types.o_auth2_grant_type.OAuth2GrantType"
    ]
    """<p>The OAuth2 grant type in the CreateConnection request. For example, <code>AUTHORIZATION_CODE</code>, <code>JWT_BEARER</code>, <code>REFRESH_TOKEN</code>, or <code>CLIENT_CREDENTIALS</code>.</p>"""
    o_auth2_client_application: NotRequired[
        "capo_glue.types.o_auth2_client_application.OAuth2ClientApplication"
    ]
    """<p>The client application type in the CreateConnection request. For example, <code>AWS_MANAGED</code> or <code>USER_MANAGED</code>.</p>"""
    token_url: NotRequired["capo_glue.types.token_url.TokenUrl"]
    """<p>The URL of the provider's authentication server, to exchange an authorization code for an access token.</p>"""
    token_url_parameters_map: NotRequired[
        "capo_glue.types.token_url_parameters_map.TokenUrlParametersMap"
    ]
    """<p>A map of parameters that are added to the token <code>GET</code> request.</p>"""
    authorization_code_properties: NotRequired[
        "capo_glue.types.authorization_code_properties.AuthorizationCodeProperties"
    ]
    """<p>The set of properties required for the the OAuth2 <code>AUTHORIZATION_CODE</code> grant type.</p>"""
    o_auth2_credentials: NotRequired[
        "capo_glue.types.o_auth2_credentials.OAuth2Credentials"
    ]
    """<p>The credentials used when the authentication type is OAuth2 authentication.</p>"""

authorization_code_properties instance-attribute

authorization_code_properties: NotRequired[AuthorizationCodeProperties]

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

o_auth2_client_application instance-attribute

o_auth2_client_application: NotRequired[OAuth2ClientApplication]

The client application type in the CreateConnection request. For example, AWS_MANAGED or USER_MANAGED.

o_auth2_credentials instance-attribute

o_auth2_credentials: NotRequired[OAuth2Credentials]

The credentials used when the authentication type is OAuth2 authentication.

o_auth2_grant_type instance-attribute

o_auth2_grant_type: NotRequired[OAuth2GrantType]

The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE, JWT_BEARER, REFRESH_TOKEN, or CLIENT_CREDENTIALS.

token_url instance-attribute

token_url: NotRequired[TokenUrl]

The URL of the provider's authentication server, to exchange an authorization code for an access token.

token_url_parameters_map instance-attribute

token_url_parameters_map: NotRequired[TokenUrlParametersMap]

A map of parameters that are added to the token GET request.