Struct OAuthConfig 

#[non_exhaustive]
pub struct OAuthConfig {
    pub auth_url: String,
    pub token_url: String,
    pub scope: Option<String>,
    pub token_endpoint_authentication_scheme: TokenEndpointAuthenticationScheme,
    pub o_auth_complete_redirect_url: Option<String>,
    pub proactive_refresh_token_renewal: Option<ProactiveRefreshTokenRenewal>,
}

Configuration details for OAuth authentication with a third-party service.

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.

auth_url: String

The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

token_url: String

The token URL for the OAuth service, where authorization codes are exchanged for access tokens.

scope: Option<String>

The OAuth scopes requested during authorization, which define the permissions granted to the application.

token_endpoint_authentication_scheme: TokenEndpointAuthenticationScheme

The authentication scheme used when requesting tokens from the token endpoint.

o_auth_complete_redirect_url: Option<String>

The URL where users are redirected after completing the OAuth authorization process.

proactive_refresh_token_renewal: Option<ProactiveRefreshTokenRenewal>

Configuration for proactively refreshing OAuth tokens before they expire.

Implementations

impl OAuthConfig

pub fn auth_url(&self) -> &str

The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

pub fn token_url(&self) -> &str

The token URL for the OAuth service, where authorization codes are exchanged for access tokens.

pub fn scope(&self) -> Option<&str>

The OAuth scopes requested during authorization, which define the permissions granted to the application.

pub fn token_endpoint_authentication_scheme( &self, ) -> &TokenEndpointAuthenticationScheme

The authentication scheme used when requesting tokens from the token endpoint.

pub fn o_auth_complete_redirect_url(&self) -> Option<&str>

The URL where users are redirected after completing the OAuth authorization process.

pub fn proactive_refresh_token_renewal( &self, ) -> Option<&ProactiveRefreshTokenRenewal>

Configuration for proactively refreshing OAuth tokens before they expire.

impl OAuthConfig

pub fn builder() -> OAuthConfigBuilder

Creates a new builder-style object to manufacture OAuthConfig.

Trait Implementations

impl Clone for OAuthConfig

fn clone(&self) -> OAuthConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthConfig

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

Formats the value using the given formatter.

impl PartialEq for OAuthConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OAuthConfig