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#
| Attribute | Type | Description |
|---|---|---|
bearer | Http | |
basic | Basic |
Types#
| Type | Definition | Description |
|---|---|---|
HttpApiSecurity | type HttpApiSecurity = Http | ApiKey | Basic | |
Credential | type Credential = Redacted[str] | Credentials | What decoding a security gives: |
Classes#
Functions#
http#
http(*, scheme) -> Http| Parameter | Type | Description |
|---|---|---|
scheme | str |
Returns Http
def http(*, scheme: str) -> Http:
return Http(scheme)api_key#
api_key(*, key, in_='header') -> ApiKey| Parameter | Type | Description |
|---|---|---|
key | str | |
in_ | Literal['header', 'query', 'cookie'] = 'header' |
Returns ApiKey
def api_key(*, key: str, in_: Literal["header", "query", "cookie"] = "header") -> ApiKey:
return ApiKey(key, in_)