Struct OAuthFlow 

pub struct OAuthFlow {
    pub authorization_url: Option<String>,
    pub token_url: Option<String>,
    pub device_authorization_url: Option<String>,
    pub refresh_url: Option<String>,
    pub scopes: Map<String>,
    pub extensions: Extensions,
}

The configuration of one OAuth 2.0 flow.

Which URL fields are required depends on the flow this is attached to. That pairing is not checked here, and the model is deliberately the permissive half: a flow read back from someone else’s description has to round-trip whatever it said. #[derive(SecurityScheme)] enforces the pairing where the flow is written, which is the layer that knows which flow it is naming.

Fields

authorization_url: Option<String>

The authorization URL. Required for the implicit and authorization code flows.

token_url: Option<String>

The token URL. Required for the password, client credentials and authorization code flows.

device_authorization_url: Option<String>

The device authorization URL. Required for the device authorization flow.

Introduced in OpenAPI 3.2.

refresh_url: Option<String>

The URL used to obtain refresh tokens.

scopes: Map<String>

The scopes available, mapped to a short description of each.

Required, though it may be empty.

extensions: Extensions

Specification extensions.

Implementations

impl OAuthFlow

pub fn new(scopes: impl IntoIterator<Item = (String, String)>) -> Self

Creates a flow with the given scopes and no URLs.

pub fn with_authorization_url(self, url: impl Into<String>) -> Self

Sets the authorization URL.

pub fn with_token_url(self, url: impl Into<String>) -> Self

Sets the token URL.

pub fn with_refresh_url(self, url: impl Into<String>) -> Self

Sets the refresh URL.

pub fn with_device_authorization_url(self, url: impl Into<String>) -> Self

Sets the device authorization URL.

Required for the device authorization flow, and legal on any of them.

Trait Implementations

impl Clone for OAuthFlow

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthFlow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OAuthFlow

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OAuthFlow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OAuthFlow

impl PartialEq for OAuthFlow

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OAuthFlow

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OAuthFlow