Struct OAuth2Config 

pub struct OAuth2Config {

    pub registration_id: String,
    pub client_id: String,
    pub client_secret: String,
    pub redirect_uri: String,
    pub provider: OAuth2Provider,
    pub authorization_uri: Option<String>,
    pub token_uri: Option<String>,
    pub userinfo_uri: Option<String>,
    pub issuer_uri: Option<String>,
    pub jwk_set_uri: Option<String>,
    pub scopes: Vec<String>,
    pub use_pkce: bool,
    pub authorization_params: HashMap<String, String>,
    pub username_attribute: String,
}

OAuth2 configuration for a client registration

Similar to Spring Security’s ClientRegistration.

Example

let config = OAuth2Config::new(
    "client-id",
    "client-secret",
    "http://localhost:8080/oauth2/callback/google"
)
.provider(OAuth2Provider::Google)
.scopes(vec!["openid", "email", "profile"]);

Fields

registration_id: String

Registration ID (e.g., “google”, “github”)

client_id: String

OAuth2 client ID

client_secret: String

OAuth2 client secret

redirect_uri: String

Redirect URI for callbacks

provider: OAuth2Provider

OAuth2 provider

authorization_uri: Option<String>

Authorization endpoint URL (optional, auto-discovered for OIDC)

token_uri: Option<String>

Token endpoint URL (optional, auto-discovered for OIDC)

userinfo_uri: Option<String>

User info endpoint URL (optional, auto-discovered for OIDC)

issuer_uri: Option<String>

OIDC issuer URL (for discovery)

jwk_set_uri: Option<String>

JWK Set URI (for ID token validation)

scopes: Vec<String>

OAuth2 scopes

use_pkce: bool

Use PKCE (Proof Key for Code Exchange)

authorization_params: HashMap<String, String>

Custom parameters for authorization request

username_attribute: String

Attribute name for username extraction

Implementations

impl OAuth2Config

pub fn new( client_id: impl Into<String>, client_secret: impl Into<String>, redirect_uri: impl Into<String>, ) -> OAuth2Config

Create a new OAuth2 configuration

Arguments

• client_id - The OAuth2 client ID
• client_secret - The OAuth2 client secret
• redirect_uri - The callback URL for authorization response

pub fn registration_id(self, id: impl Into<String>) -> OAuth2Config

Set the registration ID

pub fn provider(self, provider: OAuth2Provider) -> OAuth2Config

Set the OAuth2 provider

This will auto-configure endpoints for known providers.

pub fn authorization_uri(self, uri: impl Into<String>) -> OAuth2Config

Set the authorization endpoint URL

pub fn token_uri(self, uri: impl Into<String>) -> OAuth2Config

Set the token endpoint URL

pub fn userinfo_uri(self, uri: impl Into<String>) -> OAuth2Config

Set the user info endpoint URL

pub fn issuer_uri(self, uri: impl Into<String>) -> OAuth2Config

Set the OIDC issuer URL for auto-discovery

pub fn jwk_set_uri(self, uri: impl Into<String>) -> OAuth2Config

Set the JWK Set URI for ID token validation

pub fn scopes(self, scopes: Vec<impl Into<String>>) -> OAuth2Config

Set the OAuth2 scopes

pub fn add_scope(self, scope: impl Into<String>) -> OAuth2Config

Add a scope

pub fn use_pkce(self, use_pkce: bool) -> OAuth2Config

Enable or disable PKCE

pub fn authorization_param( self, key: impl Into<String>, value: impl Into<String>, ) -> OAuth2Config

Add a custom authorization parameter

pub fn username_attribute(self, attr: impl Into<String>) -> OAuth2Config

Set the attribute name used for extracting the username

Trait Implementations

impl Clone for OAuth2Config

fn clone(&self) -> OAuth2Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2Config

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

Formats the value using the given formatter.