Struct ExternalAuthProviderConfig

Source

pub struct ExternalAuthProviderConfig {Show 20 fields
    pub id: i64,
    pub key: String,
    pub provider_kind: ExternalAuthProviderKind,
    pub protocol: ExternalAuthProtocol,
    pub options: ExternalAuthProviderOptions,
    pub issuer_url: Option<String>,
    pub authorization_url: Option<String>,
    pub token_url: Option<String>,
    pub userinfo_url: Option<String>,
    pub client_id: String,
    pub client_secret: Option<String>,
    pub scopes: String,
    pub subject_claim: Option<String>,
    pub username_claim: Option<String>,
    pub display_name_claim: Option<String>,
    pub email_claim: Option<String>,
    pub email_verified_claim: Option<String>,
    pub groups_claim: Option<String>,
    pub avatar_url_claim: Option<String>,
    pub outbound_http_user_agent: Option<String>,
}

Expand description

Runtime configuration used by provider drivers.

The value is intentionally independent from persistence. Application crates can keep their own schema, encrypted secret handling, OpenAPI shape, and migration behavior, then construct this config immediately before invoking a provider driver.

Fields§

§id: i64

Product-owned provider id, carried through for logging and app-level correlation.

§key: String

Product-owned stable provider key.

§provider_kind: ExternalAuthProviderKind

Provider kind selected by the application.

§protocol: ExternalAuthProtocol

Protocol selected by the application.

§options: ExternalAuthProviderOptions

Connector-specific decoded options.

§issuer_url: Option<String>

Issuer URL for OIDC-style providers.

§authorization_url: Option<String>

Authorization endpoint for manual OAuth2 providers.

§token_url: Option<String>

Token endpoint for manual OAuth2 providers.

§userinfo_url: Option<String>

Userinfo endpoint for manual OAuth2 providers.

§client_id: String

OAuth/OIDC client id.

§client_secret: Option<String>

Optional OAuth/OIDC client secret.

§scopes: String

Space-separated scope list.

§subject_claim: Option<String>

Optional profile claim name or JSON pointer used as the subject.

§username_claim: Option<String>

Optional profile claim name or JSON pointer used as the preferred username.

§display_name_claim: Option<String>

Optional profile claim name or JSON pointer used as the display name.

§email_claim: Option<String>

Optional profile claim name or JSON pointer used as the email address.

§email_verified_claim: Option<String>

Optional profile claim name or JSON pointer used as the email verification flag.

§groups_claim: Option<String>

Optional profile claim name reserved for group extraction by application crates.

§avatar_url_claim: Option<String>

Optional profile claim name reserved for avatar URL extraction by application crates.

§outbound_http_user_agent: Option<String>

Optional application-owned User-Agent for outbound provider API requests.

Implementations§

Source §

impl ExternalAuthProviderConfig

Source

pub fn require_issuer_url(&self) -> Result<&str>

Returns a non-empty issuer URL or a validation error.

Trait Implementations§

Source §

impl Clone for ExternalAuthProviderConfig

Source §

fn clone(&self) -> ExternalAuthProviderConfig

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ExternalAuthProviderConfig

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ExternalAuthProviderConfig

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.

§

impl<T> Instrument for T

§

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

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

§