Struct utoipa::openapi::security::AuthorizationCode

#[non_exhaustive]
pub struct AuthorizationCode { /* private fields */ }

Authorization code Flow configuration for Oauth2.

Implementations

impl AuthorizationCode

pub fn new<A: Into<String>, T: Into<String>>(
    authorization_url: A,
    token_url: T,
    scopes: HashMap<String, String>
) -> Self

Construct a new authorization code oauth flow.

Accpets three arguments: one which is authorization url, two a token url and three a map of scopes for oauth flow.

Examples

Create new authorization code flow with scopes.

AuthorizationCode::new(
    "http://localhost/auth/dialog",
    "http://localhost/token",
    HashMap::from([
        ("edit:items".to_string(), "edit my items".to_string()),
        ("read:items".to_string(), "read my items".to_string()
    )]),
);

Create new authorization code flow without any scopes.

AuthorizationCode::new(
    "http://localhost/auth/dialog",
    "http://localhost/token",
    HashMap::new(),
);

pub fn with_refresh_url<S: Into<String>>(self, refresh_url: S) -> Self

Add refresh url for getting refresh tokens.

Trait Implementations

impl Clone for AuthorizationCode

fn clone(&self) -> AuthorizationCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for AuthorizationCode

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

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthorizationCode

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

Serialize this value into the given Serde serializer.