Skip to content

api_key_scheme

autogen.beta.a2a.security.api_key_scheme #

api_key_scheme(*, name, key_name, location='header', description='')

API key auth declaration. key_name is the header/query/cookie key sent by the client; location is "header", "query", or "cookie".

Source code in autogen/beta/a2a/security.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
def api_key_scheme(*, name: str, key_name: str, location: str = "header", description: str = "") -> Scheme:
    """API key auth declaration. ``key_name`` is the header/query/cookie key
    sent by the client; ``location`` is ``"header"``, ``"query"``, or ``"cookie"``."""
    return Scheme(
        name=name,
        scheme=SecurityScheme(
            api_key_security_scheme=APIKeySecurityScheme(
                name=key_name,
                location=location,
                description=description,
            ),
        ),
    )