Enum openapiv3::SecurityScheme

pub enum SecurityScheme {
    APIKey {
        location: APIKeyLocation,
        name: String,
        description: Option<String>,
        extensions: IndexMap<String, Value>,
    },
    HTTP {
        scheme: String,
        bearer_format: Option<String>,
        description: Option<String>,
        extensions: IndexMap<String, Value>,
    },
    OAuth2 {
        flows: OAuth2Flows,
        description: Option<String>,
        extensions: IndexMap<String, Value>,
    },
    OpenIDConnect {
        open_id_connect_url: String,
        description: Option<String>,
        extensions: IndexMap<String, Value>,
    },
}

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.

Variants

APIKey

Fields

location: APIKeyLocation

The location of the API key. Valid values are “query”, “header” or “cookie”.

name: String

The name of the header, query or cookie parameter to be used.

description: Option<String>

A short description for security scheme. CommonMark syntax MAY be used for rich text representation.

extensions: IndexMap<String, Value>

Inline extensions to this object.

HTTP

Fields

scheme: String

The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry.

bearer_format: Option<String>

description: Option<String>

A short description for security scheme. CommonMark syntax MAY be used for rich text representation.

extensions: IndexMap<String, Value>

Inline extensions to this object.

OAuth2

Fields

flows: OAuth2Flows

An object containing configuration information for the flow types supported.

description: Option<String>

A short description for security scheme. CommonMark syntax MAY be used for rich text representation.

extensions: IndexMap<String, Value>

Inline extensions to this object.

OpenIDConnect

Fields

open_id_connect_url: String

OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.

description: Option<String>

A short description for security scheme. CommonMark syntax MAY be used for rich text representation.

extensions: IndexMap<String, Value>

Inline extensions to this object.

Trait Implementations

impl Clone for SecurityScheme

fn clone(&self) -> SecurityScheme

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecurityScheme

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecurityScheme

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SecurityScheme

fn eq(&self, other: &SecurityScheme) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SecurityScheme

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecurityScheme