Struct DeviceCodeCredential

pub struct DeviceCodeCredential { /* private fields */ }

The device authorization grant: allows users to sign in to input-constrained devices such as a smart TV, IoT device, or a printer. To enable this flow, the device has the user visit a webpage in a browser on another device to sign in. Once the user signs in, the device is able to get access tokens and refresh tokens as needed.

For more info on the protocol supported by the Microsoft Identity Platform see the Microsoft identity platform and the OAuth 2.0 device authorization grant flow

Implementations

impl DeviceCodeCredential

pub fn new<U, I>( client_id: impl AsRef<str>, device_code: impl AsRef<str>, scope: I, ) -> DeviceCodeCredential

where U: ToString, I: IntoIterator<Item = U>,

pub fn with_refresh_token<T>( &mut self, refresh_token: T, ) -> &mut DeviceCodeCredential

where T: AsRef<str>,

pub fn with_device_code<T>( &mut self, device_code: T, ) -> &mut DeviceCodeCredential

where T: AsRef<str>,

pub fn builder(client_id: impl AsRef<str>) -> DeviceCodeCredentialBuilder

Trait Implementations

impl Clone for DeviceCodeCredential

fn clone(&self) -> DeviceCodeCredential

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceCodeCredential

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

Formats the value using the given formatter.

impl From<DeviceCodeCredential> for PublicClientApplication<DeviceCodeCredential>

fn from( value: DeviceCodeCredential, ) -> PublicClientApplication<DeviceCodeCredential>

Converts to this type from the input type.

impl TokenCache for DeviceCodeCredential

type Token = Token

fn get_token_silent( &mut self, ) -> Result<<DeviceCodeCredential as TokenCache>::Token, AuthExecutionError>

fn get_token_silent_async<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<<DeviceCodeCredential as TokenCache>::Token, AuthExecutionError>> + Send + 'async_trait>>

where 'life0: 'async_trait, DeviceCodeCredential: 'async_trait,

fn with_force_token_refresh(&mut self, force_token_refresh: ForceTokenRefresh)

impl TokenCredentialExecutor for DeviceCodeCredential

fn uri(&mut self) -> Result<Url, AuthorizationFailure>

fn form_urlencode( &mut self, ) -> Result<HashMap<String, String>, AuthorizationFailure>

fn client_id(&self) -> &Uuid

fn authority(&self) -> Authority

fn azure_cloud_instance(&self) -> AzureCloudInstance

fn app_config(&self) -> &AppConfig

fn request_parts( &mut self, ) -> Result<AuthorizationRequestParts, AuthorizationFailure>

fn build_request(&mut self) -> Result<RequestBuilder, AuthExecutionError>

fn build_request_async(&mut self) -> Result<RequestBuilder, AuthExecutionError>

fn basic_auth(&self) -> Option<(String, String)>

fn extra_header_parameters(&self) -> &HeaderMap

fn issuer(&self) -> Result<Url, ParseError>

fn extra_query_parameters(&self) -> &HashMap<String, String>

fn execute(&mut self) -> Result<Response, AuthExecutionError>

fn execute_async<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Response, AuthExecutionError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Send + 'async_trait,