Enum Auth 

pub enum Auth {
    None,
    Bearer {
        token: String,
    },
    Basic {
        username: String,
        password: String,
    },
    ApiKey {
        header: String,
        value: String,
    },
    ApiKeyQuery {
        param: String,
        value: String,
    },
    OAuth2 {
        token_url: String,
        client_id: String,
        client_secret: String,
        scopes: Vec<String>,
        expiry_ratio: f64,
    },
    TokenEndpoint {
        url: String,
        method: Method,
        headers: HeaderMap,
        body: Option<Value>,
        token_path: String,
        expiry_path: Option<String>,
        expiry_ratio: f64,
        response_validator: Option<ResponseValidator>,
    },
    Custom {
        headers: HashMap<String, String>,
    },
}

Available on crate feature source-rest only.

Supported authentication methods.

Variants

None

Bearer

Bearer token in the Authorization header.

Fields

token: String

Basic

Fields

username: String

password: String

ApiKey

API key sent in a request header.

Fields

header: String

value: String

ApiKeyQuery

API key sent as a query parameter (e.g. ?api_key=secret).

Some APIs require the key in the URL rather than a header. The param field is the query parameter name, and value is the key itself.

Fields

param: String

value: String

OAuth2

Fields

token_url: String

client_id: String

client_secret: String

scopes: Vec<String>

expiry_ratio: f64

Fraction of expires_in after which the cached token is considered expired and a new one is fetched. Must be in (0.0, 1.0]. Defaults to 0.9 (refresh after 90 % of the token lifetime).

TokenEndpoint

Fetch a token from an arbitrary HTTP endpoint.

The endpoint is called, the token is extracted from the JSON response using token_path (a JSONPath expression), and then used as a Bearer token (or in a custom header if header_name is set).

Tokens are cached and refreshed automatically when expiry_path is provided and the server returns an expiry value.

Fields

url: String

URL of the token endpoint.

method: Method

HTTP method for the token request (e.g. GET, POST).

headers: HeaderMap

Headers to send with the token request (e.g. API keys, content type).

body: Option<Value>

Optional JSON body for the token request.

token_path: String

JSONPath expression to extract the token string from the response.

expiry_path: Option<String>

Optional JSONPath expression to extract the expiry (in seconds) from the response. When absent, the token is cached indefinitely.

expiry_ratio: f64

Fraction of the expiry after which the token is proactively refreshed. Must be in (0.0, 1.0]. Defaults to 0.9.

response_validator: Option<ResponseValidator>

Optional callback to decide whether the token endpoint response is successful. Receives the HTTP status code. When None, defaults to status.is_success() (2xx).

Custom

Arbitrary headers attached to every request (e.g. multi-tenant routing, API keys split across several headers).

Fields

headers: HashMap<String, String>

Implementations

impl Auth

pub fn apply(&self, headers: &mut HeaderMap) -> Result<(), FaucetError>

Apply header-based auth to the request headers.

ApiKeyQuery is a no-op here — it is applied as a query parameter by RestStream::execute_request instead.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Auth

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Auth

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for Auth

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

where __S: Serializer,

Serialize this value into the given Serde serializer.