Struct utoipa::openapi::security::Implicit

#[non_exhaustive]
pub struct Implicit {
    pub authorization_url: String,
    pub refresh_url: Option<String>,
    pub scopes: Scopes,
}

Implicit Flow configuration for OAuth2.

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.

authorization_url: String

Authorization token url for the flow.

refresh_url: Option<String>

Optional refresh token url for the flow.

scopes: Scopes

Scopes required by the flow.

Implementations

impl Implicit

pub fn new<S: Into<String>>(authorization_url: S, scopes: Scopes) -> Self

Construct a new implicit oauth2 flow.

Accepts two arguments: one which is authorization url and second map of scopes. Scopes can also be an empty map.

Examples

Create new implicit flow with scopes.

Implicit::new(
    "https://localhost/auth/dialog",
    Scopes::from_iter([
        ("edit:items", "edit my items"),
        ("read:items", "read my items")
    ]),
);

Create new implicit flow without any scopes.

Implicit::new(
    "https://localhost/auth/dialog",
    Scopes::new(),
);

pub fn with_refresh_url<S: Into<String>>(
    authorization_url: S,
    scopes: Scopes,
    refresh_url: S
) -> Self

Construct a new implicit oauth2 flow with refresh url for getting refresh tokens.

This is essentially same as Implicit::new but allows defining refresh_url for the Implicit oauth2 flow.

Examples

Create a new implicit oauth2 flow with refresh token.

Implicit::with_refresh_url(
    "https://localhost/auth/dialog",
    Scopes::new(),
    "https://localhost/refresh-token"
);

Trait Implementations

impl Clone for Implicit

fn clone(&self) -> Implicit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Implicit

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Implicit

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

Serialize this value into the given Serde serializer.