APISecurityScheme class

Defines a security scheme that can be used by the operations.

Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.

Inheritance

Constructors

APISecurityScheme()
APISecurityScheme.apiKey(String name, APIParameterLocation location)
APISecurityScheme.empty()
APISecurityScheme.http(String scheme)
APISecurityScheme.oauth2(Map<String, APISecuritySchemeOAuth2Flow> flows)
APISecurityScheme.openID(Uri connectURL)

Properties

connectURL ↔ Uri
OpenId Connect URL to discover OAuth2 configuration values. [...]
read / write
description ↔ String
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
read / write
flows ↔ Map<String, APISecuritySchemeOAuth2Flow>
An object containing configuration information for the flow types supported. [...]
read / write
format ↔ String
A hint to the client to identify how the bearer token is formatted. [...]
read / write
location APIParameterLocation
The location of the API key. [...]
read / write
name ↔ String
The name of the header, query or cookie parameter to be used. [...]
read / write
scheme ↔ String
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. [...]
read / write
type APISecuritySchemeType
The type of the security scheme. [...]
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