Struct utoipa::openapi::security::ClientCredentials

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

Client credentials 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.

token_url: String

Token url used for ClientCredentials flow. OAuth2 standard requires TLS.

refresh_url: Option<String>

Optional refresh token url.

scopes: Scopes

Scopes required by the flow.

Implementations

impl ClientCredentials

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

Construct a new client crendentials oauth flow.

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

Examples

Create new client credentials flow with scopes.

ClientCredentials::new(
    "https://localhost/token",
    Scopes::from_iter([
        ("edit:items", "edit my items"),
        ("read:items", "read my items")
    ]),
);

Create new client credentials flow without any scopes.

ClientCredentials::new(
    "https://localhost/token",
    Scopes::new(),
);

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

Construct a new client crendentials oauth flow with additional refresh url.

This is essentially same as ClientCredentials::new but allows defining third paramter for refresh_url.

Examples

Create new client credentials for with refresh url.

ClientCredentials::with_refresh_url(
    "https://localhost/token",
    Scopes::from_iter([
        ("edit:items", "edit my items"),
        ("read:items", "read my items")
    ]),
    "https://localhost/refresh-url"
);

Trait Implementations

impl Clone for ClientCredentials

fn clone(&self) -> ClientCredentials

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for ClientCredentials

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

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientCredentials

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

Serialize this value into the given Serde serializer.