Struct AuthRequest 

pub struct AuthRequest {
    pub task_id: Option<TaskId>,
    pub id: String,
    pub provider: String,
    pub operation: AuthOperation,
    pub challenge: MetadataMap,
}

A request for authentication credentials before a tool can proceed.

Emitted as ToolInterruption::AuthRequired when a tool (typically an MCP integration) needs OAuth tokens, API keys, or other credentials that the user must supply interactively.

Fields

task_id: Option<TaskId>

Runtime task identifier associated with this auth request, if any.

id: String

Unique identifier for this auth challenge.

provider: String

Name of the authentication provider (e.g. "github", "google").

operation: AuthOperation

The operation that triggered the auth requirement.

challenge: MetadataMap

Provider-specific challenge data (e.g. OAuth URLs, scopes).

Implementations

impl AuthRequest

pub fn new( id: impl Into<String>, provider: impl Into<String>, operation: AuthOperation, ) -> Self

Builds an auth request with no task id and empty challenge metadata.

pub fn with_task_id(self, task_id: impl Into<TaskId>) -> Self

Sets the associated task id.

pub fn with_challenge(self, challenge: MetadataMap) -> Self

Replaces the auth challenge payload.

impl AuthRequest

pub fn server_id(&self) -> Option<&str>

Convenience accessor that delegates to AuthOperation::server_id.

Trait Implementations

impl Clone for AuthRequest

fn clone(&self) -> AuthRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AuthRequest

fn eq(&self, other: &AuthRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AuthRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AuthRequest

impl StructuralPartialEq for AuthRequest