Enum OAuthError 

#[non_exhaustive]
pub enum OAuthError {
    MissingToken,
    InvalidToken {
        description: String,
    },
    InsufficientScope {
        required: Vec<String>,
        provided: Vec<String>,
    },
    InvalidAudience,
    ExpiredToken,
}

OAuth 2.1 authentication/authorization error.

Each variant maps to a specific HTTP status code and WWW-Authenticate header value per RFC 6750 Section 3.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingToken

No bearer token was provided in the request. Returns HTTP 401 with WWW-Authenticate: Bearer.

InvalidToken

The provided token is invalid (malformed, signature mismatch, etc.). Returns HTTP 401 with error="invalid_token".

Fields

description: String

Human-readable description of why the token is invalid.

InsufficientScope

The token’s scopes are insufficient for the requested operation. Returns HTTP 403 with error="insufficient_scope".

Fields

required: Vec<String>

Scopes required by the operation.

provided: Vec<String>

Scopes present in the token.

InvalidAudience

The token’s audience does not match this resource server. Returns HTTP 401 with error="invalid_token".

ExpiredToken

The token has expired. Returns HTTP 401 with error="invalid_token".

Implementations

impl OAuthError

pub fn status_code(&self) -> u16

Returns the HTTP status code for this error.

• 401 Unauthorized for authentication failures (missing/invalid/expired token)
• 403 Forbidden for authorization failures (insufficient scope)

pub fn www_authenticate(&self, resource_metadata_url: Option<&str>) -> String

Builds the WWW-Authenticate header value per RFC 6750 Section 3.

When resource_metadata_url is provided, includes the resource_metadata parameter per RFC 9728 so clients can discover the authorization server.

Trait Implementations

impl Clone for OAuthError

fn clone(&self) -> OAuthError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthError

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

Formats the value using the given formatter.

impl Display for OAuthError

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

Formats the value using the given formatter.

impl Error for OAuthError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.