GitHub

security

API reference for security.

Where a request carries its credentials (Effect's HttpApiSecurity): an Authorization scheme (bearer, http(scheme=...)), HTTP Basic (basic) or an API key in a header, query parameter or cookie (api_key). A security middleware decodes them with HttpApiBuilder.security_decode; OpenAPI documents them.

Values

AttributeTypeDescription
bearerHttp
basicBasic

Types

TypeDefinitionDescription
HttpApiSecuritytype HttpApiSecurity = Http | ApiKey | Basic
Credentialtype Credential = Redacted[str] | Credentials

What decoding a security gives: Credentials for Basic, else a Redacted string.

Classes

Functions

http

http(*, scheme) -> Http
ParameterTypeDescription
schemestr

Returns Http

def http(*, scheme: str) -> Http:
    return Http(scheme)

api_key

api_key(*, key, in_='header') -> ApiKey
ParameterTypeDescription
keystr
in_Literal['header', 'query', 'cookie'] = 'header'

Returns ApiKey

def api_key(*, key: str, in_: Literal["header", "query", "cookie"] = "header") -> ApiKey:
    return ApiKey(key, in_)