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

• Object
• Coding
• APIObject
• APISecurityRequirement

Constructors

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

APISecurityRequirement.empty()

Properties

castMap → Map<String, Cast>?

no setter, inherited

extensions ↔ Map<String, dynamic>

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

referenceURI ↔ Uri?

getter/setter pair, inherited

requirements ↔ Map<String, List<String>>

Each name MUST correspond to a security scheme which is declared in APIComponents.securitySchemes.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

decode(KeyedArchive object) → void

override

encode(KeyedArchive object) → void

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited