SecurityScheme

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.

struct SecurityScheme {

SecurityType type;

@optional

string bearerFormat;

@optional

string description;

@optional

string name;

@optional

@SerializedName("in")

string openIdConnectUrl;

mixin Serialization!SecurityScheme ;

}

Members

Mixins

__anonymous mixin Serialization!SecurityScheme: Undocumented in source.

Variables

bearerFormat string bearerFormat;: A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
description string description;: A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
flows OAuthFlows flows;: An object containing configuration information for the flow types supported.
in_ ParameterIn in_;: The location of the API key
name string name;: The name of the header, query or cookie parameter to be used.
openIdConnectUrl string openIdConnectUrl;: OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
scheme string scheme;: The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
type SecurityType type;

SecurityScheme

Members

Mixins

Variables

Meta

Source