Skip to main content

OAuthConfig

Struct OAuthConfig 

Source
pub struct OAuthConfig {
    pub authorize_url: String,
    pub token_url: String,
    pub device_url: Option<String>,
    pub client_id: String,
    pub scope: Option<String>,
    pub beta_headers: Vec<(String, String)>,
    pub system_preamble: Option<String>,
    pub redirect: RedirectSpec,
    pub authorize_params: Vec<(String, String)>,
    pub account_header: Option<String>,
}
Expand description

The OAuth auth-row as data (auth §7.1): endpoints, client_id, scope, and the auth-mode-dependent beta_headers (e.g. anthropic-beta: oauth-…). The provider NAME is deliberately absent — it lives once, as the row key / store_key. The pure OAuth builders take &OAuthConfig, so no vendor policy is compiled into the core. Like the [[provider]] row (config §2.3), deny_unknown_fields makes a typo’d or MISPLACED key a MalformedFile rather than a silent drop — a TOP-LEVEL row key (e.g. unsupported_body_keys) typed under [provider.oauth] would otherwise vanish and the strip never fire (bl-9649).

Fields§

§authorize_url: String§token_url: String§device_url: Option<String>§client_id: String§scope: Option<String>§beta_headers: Vec<(String, String)>

Auth-mode-dependent STATIC headers (auth §4), e.g. anthropic-beta: oauth-….

§system_preamble: Option<String>

The system the request body must LEAD with under this auth mode (auth §4.1): a Claude-Code-scoped Anthropic OAuth token rejects a request whose system does not begin with You are Claude Code, Anthropic's official CLI for Claude. It is a BODY fact, so — unlike beta_headers — it cannot ride header-only apply; resolution prepends it to req.system before encode (lead_with_preamble). None ⇒ no preamble (the api-key analogue), leaving the system untouched.

§redirect: RedirectSpec

The loopback redirect as data (auth §10.1); default reproduces today’s http://127.0.0.1:{ephemeral}/callback, so existing rows are unchanged.

§authorize_params: Vec<(String, String)>

Extra authorize-URL params (auth §10.2), e.g. OpenAI’s id_token_add_organizations=true. Default empty ⇒ URL byte-identical.

§account_header: Option<String>

Header NAME for the credential’s account_id (auth §10.4), e.g. ChatGPT-Account-ID. None ⇒ the header is not emitted.

Trait Implementations§

Source§

impl Clone for OAuthConfig

Source§

fn clone(&self) -> OAuthConfig

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 OAuthConfig

Source§

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

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

impl<'de> Deserialize<'de> for OAuthConfig

Source§

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

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

impl PartialEq for OAuthConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for OAuthConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for OAuthConfig

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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.