Struct OAuth2 

#[non_exhaustive]
pub struct OAuth2 {
    pub flows: BTreeMap<String, Flow>,
    pub oauth2_metadata_url: Option<String>,
    pub description: Option<String>,
    pub deprecated: Option<Deprecated>,
    pub extensions: Option<Extensions>,
}

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.

oauth2_metadata_url: Option<String>

URL to OAuth2 authorization server metadata.

description: Option<String>

Optional description for the OAuth2 Flow SecurityScheme.

deprecated: Option<Deprecated>

Declares whether the security scheme is deprecated.

extensions: Option<Extensions>

Optional extensions “x-something”.

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");

pub fn with_metadata_url<S: Into<String>>(self, oauth2_metadata_url: S) -> Self

Add OAuth2 authorization server metadata URL.

Examples

Add authorization server metadata URL to an existing OAuth2 security scheme.

OAuth2::new([Flow::Password(
    Password::new(
        "https://localhost/oauth/token",
        Scopes::from_iter([("edit:items", "edit my items")]),
    ),
)])
.with_metadata_url("https://localhost/.well-known/oauth-authorization-server");

pub fn deprecated(self, deprecated: Option<Deprecated>) -> Self

Add or change deprecated status.

Declaring a security scheme deprecated signals to API consumers that they should migrate away from it. This is an OpenAPI 3.2 addition available on all SecurityScheme variants.

Examples

Mark an OAuth2 security scheme as deprecated.

OAuth2::new([Flow::Password(
    Password::new(
        "https://localhost/oauth/token",
        Scopes::from_iter([("edit:items", "edit my items")]),
    ),
)])
.deprecated(Some(Deprecated::True));

Trait Implementations

impl Clone for OAuth2

fn clone(&self) -> OAuth2

Returns a duplicate 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 Eq for OAuth2

impl PartialEq for OAuth2

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for OAuth2