Enum AuthMethod 

pub enum AuthMethod {
    VirtualKey {
        virtual_key: String,
    },
    ProviderAuth {
        provider: String,
        authorization: String,
        custom_host: Option<String>,
    },
    Config {
        config_id: String,
    },
}

Authentication method for Portkey API.

Portkey supports multiple authentication methods for routing requests to different LLM providers.

Variants

VirtualKey

Virtual Key authentication - managed provider credentials in Portkey.

Uses x-portkey-virtual-key header. Virtual keys are managed in the Portkey dashboard and securely store provider API keys.

Example

use portkey_sdk::builder::AuthMethod;

let auth = AuthMethod::VirtualKey {
    virtual_key: "your-virtual-key".to_string(),
};

Fields

virtual_key: String

The virtual key ID from Portkey dashboard

ProviderAuth

Provider authentication with direct provider credentials.

Uses x-portkey-provider and Authorization headers to directly authenticate with a provider.

Example

use portkey_sdk::builder::AuthMethod;

let auth = AuthMethod::ProviderAuth {
    provider: "openai".to_string(),
    authorization: "Bearer sk-...".to_string(),
    custom_host: None,
};

Fields

provider: String

Provider name (e.g., “openai”, “anthropic”, “google”)

authorization: String

Authorization header value (e.g., “Bearer sk-…”)

custom_host: Option<String>

Optional custom host URL for self-hosted or enterprise endpoints

Config

Config-based authentication using Portkey configs.

Uses x-portkey-config header. Configs define complex routing, fallback, and load balancing rules in the Portkey dashboard.

Example

use portkey_sdk::builder::AuthMethod;

let auth = AuthMethod::Config {
    config_id: "pc-config-123".to_string(),
};

Fields

config_id: String

The config ID from Portkey dashboard

Implementations

impl AuthMethod

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

Creates a virtual key authentication method.

Example

use portkey_sdk::builder::AuthMethod;

let auth = AuthMethod::virtual_key("your-virtual-key");

pub fn provider_auth( provider: impl Into<String>, authorization: impl Into<String>, ) -> Self

Creates a provider authentication method.

Example

use portkey_sdk::builder::AuthMethod;

let auth = AuthMethod::provider_auth("openai", "Bearer sk-...");

pub fn provider_auth_with_host( provider: impl Into<String>, authorization: impl Into<String>, custom_host: impl Into<String>, ) -> Self

Creates a provider authentication method with a custom host.

Example

use portkey_sdk::builder::AuthMethod;

let auth = AuthMethod::provider_auth_with_host(
    "openai",
    "Bearer sk-...",
    "https://custom.openai.com"
);

pub fn config(config_id: impl Into<String>) -> Self

Creates a config-based authentication method.

Example

use portkey_sdk::builder::AuthMethod;

let auth = AuthMethod::config("pc-config-123");

Trait Implementations

impl Clone for AuthMethod

fn clone(&self) -> AuthMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthMethod

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

Formats the value using the given formatter.