Enum utoipa::openapi::security::SecurityScheme

pub enum SecurityScheme {
    OAuth2(OAuth2),
    ApiKey(ApiKey),
    Http(Http),
    OpenIdConnect(OpenIdConnect),
    MutualTls {
        description: Option<String>,
    },
}

OpenAPI security scheme for path operations.

Examples

Create implicit oauth2 flow security schema for path operations.

SecurityScheme::OAuth2(
    OAuth2::with_description([Flow::Implicit(
        Implicit::new(
            "https://localhost/auth/dialog",
            Scopes::from_iter([
                ("edit:items", "edit my items"),
                ("read:items", "read my items")
            ]),
        ),
    )], "my oauth2 flow")
);

Create JWT header authentication.

SecurityScheme::Http(
    HttpBuilder::new().scheme(HttpAuthScheme::Bearer).bearer_format("JWT").build()
);

Variants

OAuth2(OAuth2)

Oauth flow authentication.

ApiKey(ApiKey)

Api key authentication sent in header, cookie or query.

Http(Http)

Http authentication such as bearer or basic.

OpenIdConnect(OpenIdConnect)

Open id connect url to discover OAuth2 configuration values.

MutualTls

Authentication is done via client side certificate.

OpenApi 3.1 type

Fields

description: Option<String>

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<'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

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 Eq for SecurityScheme

impl StructuralPartialEq for SecurityScheme