Struct utoipa::openapi::security::AuthorizationCode
source · #[non_exhaustive]pub struct AuthorizationCode {
pub authorization_url: String,
pub token_url: String,
pub refresh_url: Option<String>,
pub scopes: Scopes,
}
Fields (Non-exhaustive)
This struct is marked as 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.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
sourceimpl AuthorizationCode
impl AuthorizationCode
sourcepub fn new<A: Into<String>, T: Into<String>>(
authorization_url: A,
token_url: T,
scopes: Scopes
) -> Self
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.
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(
"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(),
);
sourcepub fn with_refresh_url<S: Into<String>>(
authorization_url: S,
token_url: S,
scopes: Scopes,
refresh_url: S
) -> Self
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
sourceimpl Clone for AuthorizationCode
impl Clone for AuthorizationCode
sourcefn clone(&self) -> AuthorizationCode
fn clone(&self) -> AuthorizationCode
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl<'de> Deserialize<'de> for AuthorizationCode
impl<'de> Deserialize<'de> for AuthorizationCode
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Serialize for AuthorizationCode
impl Serialize for AuthorizationCode
Auto Trait Implementations
impl RefUnwindSafe for AuthorizationCode
impl Send for AuthorizationCode
impl Sync for AuthorizationCode
impl Unpin for AuthorizationCode
impl UnwindSafe for AuthorizationCode
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more