Skip to content

CorsDict

Dictionary Type

CorsDict

Bases: TypedDict

Dictionary form of Cors.

Attributes

allow_credentials instance-attribute
allow_credentials: bool | None

Whether to allow cookies or other credentials in requests to your function URL. The default is false.

allow_headers instance-attribute
allow_headers: Sequence[str] | None

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

allow_methods instance-attribute
allow_methods: Sequence[str] | None

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

allow_origins instance-attribute
allow_origins: Sequence[str] | None

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.

Alternatively, you can grant access to all origins using the wildcard character (*).

expose_headers instance-attribute
expose_headers: Sequence[str] | None

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.

max_age instance-attribute
max_age: int | None

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.