Struct utoipa::openapi::security::OAuth2

#[non_exhaustive]
pub struct OAuth2 {
    pub flows: BTreeMap<String, Flow>,
    pub description: Option<String>,
}

OAuth2 Flow configuration for SecurityScheme.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

flows: BTreeMap<String, Flow>

Map of supported OAuth2 flows.

description: Option<String>

Optional description for the OAuth2 Flow SecurityScheme.

Implementations

impl OAuth2

pub fn new<I: IntoIterator<Item = Flow>>(flows: I) -> Self

Construct a new OAuth2 security schema configuration object.

Oauth flow accepts slice of Flow configuration objects and can be optionally provided with description.

Examples

Create new OAuth2 flow with multiple authentication flows.

OAuth2::new([Flow::Password(
    Password::with_refresh_url(
        "https://localhost/oauth/token",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ]),
        "https://localhost/refresh/token"
    )),
    Flow::AuthorizationCode(
        AuthorizationCode::new(
        "https://localhost/authorization/token",
        "https://localhost/token/url",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ])),
   ),
]);

pub fn with_description<I: IntoIterator<Item = Flow>, S: Into<String>>(
    flows: I,
    description: S
) -> Self

Construct a new OAuth2 flow with optional description supporting markdown syntax.

Examples

Create new OAuth2 flow with multiple authentication flows with description.

OAuth2::with_description([Flow::Password(
    Password::with_refresh_url(
        "https://localhost/oauth/token",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ]),
        "https://localhost/refresh/token"
    )),
    Flow::AuthorizationCode(
        AuthorizationCode::new(
        "https://localhost/authorization/token",
        "https://localhost/token/url",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ])
     ),
   ),
], "my oauth2 flow");

Trait Implementations

impl Clone for OAuth2

fn clone(&self) -> OAuth2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for OAuth2

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OAuth2

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

Serialize this value into the given Serde serializer.