Struct DeviceAuthorization 

#[non_exhaustive]
pub struct DeviceAuthorization {
    pub device_authorization_url: String,
    pub token_url: String,
    pub refresh_url: Option<String>,
    pub scopes: Scopes,
    pub extensions: PropMap<String, Value>,
}

Device authorization Flow configuration for OAuth2, as defined by RFC8628. Added in OpenAPI 3.2.

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.

device_authorization_url: String

Device authorization url for this flow. OAuth2 standard requires TLS.

token_url: String

Token url for this flow. OAuth2 standard requires TLS.

refresh_url: Option<String>

Optional refresh token url.

scopes: Scopes

Scopes required by the flow.

extensions: PropMap<String, Value>

Optional extensions “x-something”

Implementations

impl DeviceAuthorization

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

Construct a new device authorization OAuth flow.

Examples

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

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

Construct a new device authorization OAuth flow with an additional refresh URL.

Examples

DeviceAuthorization::with_refresh_url(
    "https://localhost/device_authorization",
    "https://localhost/token",
    Scopes::new(),
    "https://localhost/refresh-token",
);

pub fn extensions(self, extensions: PropMap<String, Value>) -> Self

Add openapi extensions (x-something) for DeviceAuthorization.

Trait Implementations

impl Clone for DeviceAuthorization

fn clone(&self) -> DeviceAuthorization

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceAuthorization

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeviceAuthorization

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DeviceAuthorization

impl PartialEq for DeviceAuthorization

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DeviceAuthorization

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 DeviceAuthorization