Struct utoipa::openapi::security::AuthorizationCode

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

Authorization code 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

Url for authorization token.

token_url: String

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 AuthorizationCode

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

Construct a new authorization code oauth flow.

Accepts 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(
    "https://localhost/auth/dialog",
    "https://localhost/token",
    Scopes::from_iter([
        ("edit:items", "edit my items"),
        ("read:items", "read my items")
    ]),
);

Create new authorization code flow without any scopes.

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

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

Construct a new AuthorizationCode OAuth2 flow with additional refresh token url.

This is essentially same as AuthorizationCode::new but allows defining extra parameter refresh_url for fetching refresh token.

Examples

Create AuthorizationCode OAuth2 flow with refresh url.

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

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 PartialEq for AuthorizationCode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Eq for AuthorizationCode

impl StructuralPartialEq for AuthorizationCode