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: Option<Extensions>,
}

Device authorization 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.

device_authorization_url: String

Device authorization endpoint URL for the flow.

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.

extensions: Option<Extensions>

Optional extensions “x-something”.

Implementations

impl DeviceAuthorization

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

Construct a new device authorization OAuth2 flow.

First parameter is the device authorization endpoint URL where the client requests a device code, second parameter is the token URL used to poll for the access token, and the third parameter defines the scopes available for the flow.

Examples

Create a device authorization flow and use it in an OAuth2 security scheme.

OAuth2::new([Flow::DeviceAuthorization(
    DeviceAuthorization::new(
        "https://localhost/oauth/device/code",
        "https://localhost/oauth/token",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read 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 OAuth2 flow with additional refresh URL.

Examples

Create a device authorization flow with a refresh token URL.

DeviceAuthorization::with_refresh_url(
    "https://localhost/oauth/device/code",
    "https://localhost/oauth/token",
    Scopes::from_iter([("edit:items", "edit my items")]),
    "https://localhost/oauth/refresh",
);

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<'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