Enum SecurityScheme 

pub enum SecurityScheme {
    ApiKey {
        description: Option<String>,
        name: String,
        location: String,
    },
    Http {
        description: Option<String>,
        scheme: String,
        bearer_format: Option<String>,
    },
    OAuth2 {
        description: Option<String>,
        flows: Flows,
    },
    OpenIdConnect {
        description: Option<String>,
        open_id_connect_url: String,
    },
    MutualTls {
        description: Option<String>,
    },
}

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.

See https://spec.openapis.org/oas/v3.1.1#security-scheme-object.

Variants

ApiKey

API key authentication.

Fields

description: Option<String>

Description for security scheme.

CommonMark syntax MAY be used for rich text representation.

name: String

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

location: String

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

Http

HTTP authentication.

Fields

description: Option<String>

Description for security scheme.

CommonMark syntax MAY be used for rich text representation.

scheme: String

Name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC 7235.

The values used SHOULD be registered in the IANA Authentication Scheme registry.

bearer_format: Option<String>

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.

OAuth2

OAuth2 authentication.

Fields

description: Option<String>

Description for security scheme.

CommonMark syntax MAY be used for rich text representation.

flows: Flows

An object containing configuration information for the flow types supported.

OpenIdConnect

OpenID Connect authentication.

Fields

description: Option<String>

Description for security scheme.

CommonMark syntax MAY be used for rich text representation.

open_id_connect_url: String

OpenID Connect URL to discover OAuth2 configuration values.

The OpenID Connect standard requires the use of TLS.

MutualTls

Mutual TLS authentication.

Fields

description: Option<String>

Description for security scheme.

CommonMark syntax MAY be used for rich text representation.

Trait Implementations

impl Clone for SecurityScheme

fn clone(&self) -> SecurityScheme

Returns a duplicate 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 FromRef for SecurityScheme

fn from_ref(spec: &Spec, path: &str) -> Result<Self, RefError>

Finds an object in spec using the given path.

impl PartialEq for SecurityScheme

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

Tests for self and other values to be equal, and is used by ==.

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

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