APISecurityRequirement class

Lists the required security schemes to execute an operation.

The name used for each property MUST correspond to a security scheme declared in APIComponents.securitySchemes. APISecurityRequirement that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information. When a list of APISecurityRequirement is defined on the APIDocument or APIOperation, only one of APISecurityRequirement in the list needs to be satisfied to authorize the request.

Inheritance

Constructors

APISecurityRequirement(Map<String, List<String>> requirements)
APISecurityRequirement.empty()

Properties

requirements ↔ Map<String, List<String>>
Each name MUST correspond to a security scheme which is declared in APIComponents.securitySchemes. [...]
read / write
castMap → Map<String, Cast>
read-only, inherited
extensions ↔ Map<String, dynamic>
read / write, inherited
hashCode → int
The hash code for this object.
read-only, inherited
referenceURI ↔ Uri
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

decode(KeyedArchive object) → void
override
encode(KeyedArchive object) → void
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited