Skip to main content

OidcClientRawConfig

Struct OidcClientRawConfig 

Source
pub struct OidcClientRawConfig<PC>{
    pub client_id: Option<String>,
    pub client_secret: Option<String>,
    pub remote: OAuthProviderRemoteConfig,
    pub provider_oidc: OAuthProviderOidcConfig,
    pub scopes: Vec<String>,
    pub required_scopes: Vec<String>,
    pub claims_check_script: Option<String>,
    pub pkce_enabled: bool,
    pub redirect_url: Option<String>,
    pub pending_store: Option<PC>,
    pub device_poll_interval: Duration,
}
Expand description

Raw (pre-resolution) OIDC client configuration that allows optional fields to be filled from an [oidc] shared-defaults block.

Unlike OidcClientConfig, client_id here is optional so that it can be omitted from [oidc_client] and inherited from [oidc] instead. Call OidcClientRawConfig::apply_shared_defaults to resolve into a validated OidcClientConfig.

§Resolution order: local > [oidc] shared > hardcoded default

Supported shared fields (from [oidc]):

  • well_known_url, issuer_url, jwks_uri — true presence-aware
  • client_id, client_secret — presence-aware optional credentials

Shareable from [oidc]:

  • required_scopes — presence-aware (local non-empty wins; else shared)

Not shared (must stay in [oidc_client]):

  • scopes, redirect_url, pkce_enabled, claims_check_script

Fields§

§client_id: Option<String>

Local client_id. If absent, falls back to [oidc].client_id.

§client_secret: Option<String>

Local client_secret. If absent, falls back to [oidc].client_secret.

§remote: OAuthProviderRemoteConfig

Local provider connectivity. URL fields fall back to [oidc] if absent.

§provider_oidc: OAuthProviderOidcConfig

OIDC-specific overrides (never shared).

§scopes: Vec<String>§required_scopes: Vec<String>

Scopes that MUST be present in the token endpoint response. Falls back to [oidc].required_scopes when local is empty.

§claims_check_script: Option<String>§pkce_enabled: bool§redirect_url: Option<String>

Explicit redirect URL. When None (the default), each auth context uses its own hardcoded callback path at resolution time. In the combined apps/webui + apps/server deployment this field has no effect and will produce a startup warning if set.

§pending_store: Option<PC>§device_poll_interval: Duration

Implementations§

Source§

impl<PC> OidcClientRawConfig<PC>

Source

pub fn apply_shared_defaults( self, shared: &OidcSharedConfig, ) -> Result<OidcClientConfig<PC>, OidcError>

Apply shared defaults from an [oidc] block and produce the final OidcClientConfig. Returns an error if client_id cannot be resolved (neither local nor shared has a value).

Source

pub fn resolve_config( self, shared: &OidcSharedConfig, ) -> Result<OidcClientConfig<PC>, OidcError>

Recommended entry point. Resolve shared defaults and validate in one step.

Equivalent to self.apply_shared_defaults(shared)?.validate() but returns the validated config directly, eliminating manual glue.

[oidc]          ──┐
                  ├──▸ resolve_config() ──▸ validated OidcClientConfig
[oidc_client]   ──┘

Trait Implementations§

Source§

impl<PC> Clone for OidcClientRawConfig<PC>

Source§

fn clone(&self) -> OidcClientRawConfig<PC>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<PC> Debug for OidcClientRawConfig<PC>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<PC> Default for OidcClientRawConfig<PC>

Source§

fn default() -> OidcClientRawConfig<PC>

Returns the “default value” for a type. Read more
Source§

impl<'de, PC> Deserialize<'de> for OidcClientRawConfig<PC>

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<OidcClientRawConfig<PC>, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<PC> From<&OidcClientRawConfig<PC>> for OptionalTokenSetOidcSharedIntersectionConfig

Source§

fn from(value: &OidcClientRawConfig<PC>) -> Self

Converts to this type from the input type.
Source§

impl<PC> From<&OidcClientRawConfig<PC>> for TokenSetOidcSharedIntersectionConfig

Source§

fn from(value: &OidcClientRawConfig<PC>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<PC> Freeze for OidcClientRawConfig<PC>
where PC: Freeze,

§

impl<PC> RefUnwindSafe for OidcClientRawConfig<PC>
where PC: RefUnwindSafe,

§

impl<PC> Send for OidcClientRawConfig<PC>

§

impl<PC> Sync for OidcClientRawConfig<PC>

§

impl<PC> Unpin for OidcClientRawConfig<PC>
where PC: Unpin,

§

impl<PC> UnsafeUnpin for OidcClientRawConfig<PC>
where PC: UnsafeUnpin,

§

impl<PC> UnwindSafe for OidcClientRawConfig<PC>
where PC: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,