Skip to main content

Auth

Enum Auth 

Source
pub enum Auth {
    ClientCredentials {
        client_id: String,
        client_secret: String,
    },
    Bearer {
        token: String,
    },
    Password {
        user: String,
        pass: String,
        client_id: Option<String>,
    },
    RefreshToken {
        refresh_token: String,
        client_id: String,
        client_secret: Option<String>,
    },
}
Expand description

How the SDK authenticates. Configure once when building the client.

The Debug impl redacts the secret-bearing fields (client_secret, pass, token, refresh_token) so a stray {:?} in logs or an error report can’t leak credentials.

Variants§

§

ClientCredentials

Server-to-server OAuth2 client_credentials grant against /oauth/token, resolved at connect into a bearer token and transparently re-granted shortly before it expires. Requires an OAuth2 application (client id/secret); see the Authentication guide for the current availability caveat.

Fields

§client_id: String

OAuth2 application client id.

§client_secret: String

OAuth2 application client secret.

§

Bearer

A bearer token you already hold (e.g. the access token from a PKCE flow). Used as-is for the client’s lifetime — the SDK cannot renew a token it didn’t obtain itself.

Fields

§token: String

The bearer access token, sent as Authorization: Bearer <token>.

§

Password

OAuth2 password grant against /oauth/token, resolved at connect and transparently re-granted shortly before the token expires.

Fields

§user: String

Resource-owner username.

§pass: String

Resource-owner password.

§client_id: Option<String>

OAuth2 client id to present with the grant. None uses the default "manager" client; set it to authenticate through a custom OAuth2 application — matching the TypeScript/Go SDKs.

§

RefreshToken

A refresh token from the Authorization Code + PKCE flow, exchanged at connect into a bearer token and transparently re-exchanged shortly before that token expires — matching the TypeScript/Go SDKs. Refresh tokens are rotated on every use: the SDK captures the newly issued refresh token from each grant response and uses it for the next exchange.

Fields

§refresh_token: String

The refresh token to exchange for an access token.

§client_id: String

OAuth2 application client id the refresh token was issued to.

§client_secret: Option<String>

Client secret, for refresh tokens issued to a confidential client. None (public PKCE clients) omits it from the exchange — matching the TypeScript/Go SDKs.

Trait Implementations§

Source§

impl Clone for Auth

Source§

fn clone(&self) -> Auth

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 Auth

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Auth

§

impl RefUnwindSafe for Auth

§

impl Send for Auth

§

impl Sync for Auth

§

impl Unpin for Auth

§

impl UnsafeUnpin for Auth

§

impl UnwindSafe for Auth

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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