Struct Scheme

pub struct Scheme {
    pub type: String,
    pub description: Option<String>,
    pub name: Option<String>,
    pub in: Option<In>,
    pub scheme: Option<String>,
    pub flows: HashMap<String, Flow>,
    pub open_id_connect_url: Option<String>,
}

The Authentication Scheme extends the OpenAPI security spec for support of OAuth2.0, API Key, and OpenID Connect authentication.

Fields

type: String

The authentication scheme type used to access the data (http | s3 | signedUrl | oauth2 | apiKey | openIdConnect | a custom scheme type ).

description: Option<String>

Additional instructions for authentication.

CommonMark 0.29 syntax MAY be used for rich text representation.

name: Option<String>

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

in: Option<In>

The location of the API key (query | header | cookie).

scheme: Option<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. (basic | bearer | digest | dpop | hoba | mutual | negotiate | oauth (1.0) | privatetoken | scram-sha-1 | scram-sha-256 | vapid)

flows: HashMap<String, Flow>

Scenarios an API client performs to get an access token from the authorization server.

For oauth2 the following keys are pre-defined for the corresponding OAuth flows: authorizationCode | implicit | password | clientCredentials. The OAuth2 Flow Object applies for oauth2, the Signed URL Object applies to signedUrl.

open_id_connect_url: Option<String>

OpenID Connect URL to discover OpenID configuration values.

This MUST be in the form of a URL.

Trait Implementations

impl Debug for Scheme

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scheme

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Scheme

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

where __S: Serializer,

Serialize this value into the given Serde serializer.