Skip to content

ClientCredentialsProperties

Source code in docs_src/capo_glue/types/client_credentials_properties.py
class ClientCredentialsProperties(TypedDict, closed=True):
    token_url: NotRequired["capo_glue.types.connector_property.ConnectorProperty"]
    """<p>The token endpoint URL where the client will request access tokens using client credentials.</p>"""
    request_method: NotRequired["capo_glue.types.http_method.HTTPMethod"]
    """<p>The HTTP method to use when making token requests, typically POST.</p>"""
    content_type: NotRequired["capo_glue.types.content_type.ContentType"]
    """<p>The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.</p>"""
    client_id: NotRequired["capo_glue.types.connector_property.ConnectorProperty"]
    """<p>The OAuth2 client identifier provided by the authorization server.</p>"""
    client_secret: NotRequired["capo_glue.types.connector_property.ConnectorProperty"]
    """<p>The OAuth2 client secret provided by the authorization server.</p>"""
    scope: NotRequired["capo_glue.types.connector_property.ConnectorProperty"]
    """<p>The OAuth2 scope that defines the level of access requested for the client credentials flow.</p>"""
    token_url_parameters: NotRequired[
        "capo_glue.types.connector_property_list.ConnectorPropertyList"
    ]
    """<p>Additional parameters to include in token URL requests as key-value pairs.</p>"""

client_id instance-attribute

client_id: NotRequired[ConnectorProperty]

The OAuth2 client identifier provided by the authorization server.

client_secret instance-attribute

client_secret: NotRequired[ConnectorProperty]

The OAuth2 client secret provided by the authorization server.

content_type instance-attribute

content_type: NotRequired[ContentType]

The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.

request_method instance-attribute

request_method: NotRequired[HTTPMethod]

The HTTP method to use when making token requests, typically POST.

scope instance-attribute

scope: NotRequired[ConnectorProperty]

The OAuth2 scope that defines the level of access requested for the client credentials flow.

token_url instance-attribute

token_url: NotRequired[ConnectorProperty]

The token endpoint URL where the client will request access tokens using client credentials.

token_url_parameters instance-attribute

token_url_parameters: NotRequired[ConnectorPropertyList]

Additional parameters to include in token URL requests as key-value pairs.