Skip to main content

AuthClient

Struct AuthClient 

Source
pub struct AuthClient { /* private fields */ }
Expand description

Authentication client for APS

Handles OAuth 2.0 token acquisition for both 2-legged and 3-legged flows.

Implementations§

Source§

impl AuthClient

Source

pub async fn login_device(&self, scopes: &[&str]) -> Result<StoredToken>

Login with 3-legged OAuth using manual PKCE flow (headless-friendly).

  1. Generates a PKCE code verifier / challenge pair.
  2. Prints an authorization URL for the user to open in any browser.
  3. Prompts the user to paste back the callback URL (or bare code).
  4. Exchanges the authorization code + verifier for tokens.
Source§

impl AuthClient

Source

pub async fn get_3leg_token(&self) -> Result<String>

Get a valid 3-legged access token (requires prior login)

Uses Mutex-based coordination to ensure only one refresh occurs at a time. Concurrent callers wait and receive the newly refreshed token.

Source

pub async fn is_logged_in(&self) -> bool

Check if user is logged in with 3-legged OAuth

Source

pub async fn login(&self, scopes: &[&str]) -> Result<StoredToken>

Start 3-legged OAuth login flow

Source

pub async fn logout(&self) -> Result<()>

Logout - clear stored tokens

Source

pub async fn get_user_info(&self) -> Result<UserInfo>

Get user profile information (requires 3-legged auth with user:read or user-profile:read scope)

Source

pub async fn get_token_expiry(&self) -> Option<i64>

Get token expiry timestamp

Source§

impl AuthClient

Source

pub fn delete_stored_token(&self) -> Result<()>

Delete stored token

Source

pub async fn login_with_token( &self, access_token: String, refresh_token: Option<String>, expires_in: u64, scopes: Vec<String>, ) -> Result<StoredToken>

Login with a provided access token (for CI/CD scenarios)

Source§

impl AuthClient

Source

pub async fn get_token(&self) -> Result<String>

Get a valid 2-legged access token

Source

pub async fn test_auth(&self) -> Result<()>

Test 2-legged authentication

Source

pub async fn clear_cache(&self)

Clear the cached 2-legged token

Source§

impl AuthClient

Source

pub fn new(config: Config) -> Self

Create a new authentication client

Source

pub fn new_with_http_config( config: Config, http_config: HttpClientConfig, ) -> Self

Create a new authentication client with custom HTTP config

Source

pub fn config(&self) -> &Config

Get config reference

Trait Implementations§

Source§

impl Clone for AuthClient

Source§

fn clone(&self) -> AuthClient

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

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