Auth

Enum Auth 

Source
pub enum Auth {
    ApiKey(String),
    FromEnv,
    ClaudeCli,
    OAuth {
        token: String,
    },
    Resolved(Credential),
    Bedrock {
        region: String,
    },
    Vertex {
        project: String,
        region: String,
    },
    Foundry {
        resource: String,
    },
}
Expand description

Primary authentication configuration for SDK usage.

Auth provides a unified interface for all authentication methods. Use this enum to configure how the SDK authenticates with Claude API.

§Variants

  • ApiKey: Direct API key authentication
  • FromEnv: Load API key from ANTHROPIC_API_KEY environment variable
  • ClaudeCli: Use credentials from Claude Code CLI (requires cli-integration feature)
  • OAuth: OAuth token authentication
  • Resolved: Pre-resolved credential (for testing or credential reuse)
  • Bedrock: AWS Bedrock (requires aws feature)
  • Vertex: GCP Vertex AI (requires gcp feature)
  • Foundry: Azure Foundry (requires azure feature)

Variants§

§

ApiKey(String)

Direct API key authentication.

§

FromEnv

Load API key from ANTHROPIC_API_KEY environment variable.

§

ClaudeCli

Available on crate feature cli-integration only.

Use credentials from Claude Code CLI (~/.claude/credentials.json). Requires cli-integration feature.

§

OAuth

OAuth token authentication.

Fields

§token: String
§

Resolved(Credential)

Use a pre-resolved credential directly. Useful for testing, credential reuse, or custom credential sources.

§

Bedrock

Available on crate feature aws only.

Fields

§region: String
§

Vertex

Available on crate feature gcp only.

Fields

§project: String
§region: String
§

Foundry

Available on crate feature azure only.

Fields

§resource: String

Implementations§

Source§

impl Auth

Source

pub fn api_key(key: impl Into<String>) -> Self

Source

pub fn from_env() -> Self

Source

pub fn claude_cli() -> Self

Available on crate feature cli-integration only.
Source

pub fn oauth(token: impl Into<String>) -> Self

Source

pub fn bedrock(region: impl Into<String>) -> Self

Available on crate feature aws only.
Source

pub fn vertex(project: impl Into<String>, region: impl Into<String>) -> Self

Available on crate feature gcp only.
Source

pub fn foundry(resource: impl Into<String>) -> Self

Available on crate feature azure only.
Source

pub fn resolved(credential: Credential) -> Self

Use a pre-resolved credential directly.

Source

pub async fn resolve(&self) -> Result<Credential>

Resolve authentication to internal credential format.

Source

pub async fn resolve_with_provider( &self, ) -> Result<(Credential, Option<Arc<dyn CredentialProvider>>)>

Resolve authentication and return both credential and provider.

Returns the credential provider for auth methods that support token refresh. This enables automatic 401 retry with credential refresh.

Source

pub fn is_cloud_provider(&self) -> bool

Source

pub fn is_oauth(&self) -> bool

Source

pub fn supports_server_tools(&self) -> bool

Check if Anthropic’s server-side tools (WebSearch, WebFetch) are available.

Server-side tools are available with Anthropic direct API (API Key or OAuth) but NOT with cloud providers (Bedrock, Vertex, Foundry).

Trait Implementations§

Source§

impl Clone for Auth

Source§

fn clone(&self) -> Auth

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 Default for Auth

Source§

fn default() -> Auth

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

impl From<&str> for Auth

Source§

fn from(key: &str) -> Self

Converts to this type from the input type.
Source§

impl From<Credential> for Auth

Source§

fn from(credential: Credential) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Auth

Source§

fn from(key: String) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Auth

§

impl RefUnwindSafe for Auth

§

impl Send for Auth

§

impl Sync for Auth

§

impl Unpin 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<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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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