Skip to main content

AuthContext

Struct AuthContext 

Source
pub struct AuthContext {
    pub subject: String,
    pub scopes: Vec<String>,
    pub claims: HashMap<String, Value>,
    pub token: Option<String>,
    pub client_id: Option<String>,
    pub expires_at: Option<u64>,
    pub authenticated: bool,
}
Available on non-WebAssembly only.
Expand description

Authentication context containing validated user information.

This is the only auth type your MCP code should interact with. It provides a provider-agnostic view of the authenticated user, regardless of whether the token came from Cognito, Entra, Google, Okta, or any other OIDC provider.

§Provider-Agnostic Access

Use the helper methods like email(), tenant_id(), and user_id() instead of directly accessing claims. These methods handle the different claim names used by various OAuth providers.

§Example

use pmcp::server::auth::AuthContext;

fn get_user_greeting(auth: &AuthContext) -> String {
    let name = auth.email().unwrap_or(auth.user_id());
    format!("Welcome, {}!", name)
}

Fields§

§subject: String

Subject identifier (user ID from the sub claim).

§scopes: Vec<String>

Granted scopes/permissions.

§claims: HashMap<String, Value>

Additional claims from the token. Use the helper methods like email() for common claims.

§token: Option<String>

Original token if available (for forwarding to downstream services).

§client_id: Option<String>

Client ID that authenticated.

§expires_at: Option<u64>

Token expiration timestamp (Unix epoch seconds).

§authenticated: bool

Whether this context represents an authenticated user.

Implementations§

Source§

impl AuthContext

Source

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

Create a new authenticated context.

Source

pub fn anonymous() -> Self

Create an anonymous (unauthenticated) context.

Source

pub fn user_id(&self) -> &str

Get the user ID (alias for subject).

This is the standard user identifier, typically from the sub claim.

Source

pub fn claim<T: DeserializeOwned>(&self, key: &str) -> Option<T>

Get a typed claim value.

§Example
use pmcp::server::auth::AuthContext;

let auth = AuthContext::new("user-123");
let roles: Option<Vec<String>> = auth.claim("roles");
Source

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

Get the email address (handles different claim names across providers).

This method checks common claim names used by different OAuth providers:

  • email (Cognito, Google, Okta, Auth0)
  • preferred_username (Entra ID)
  • upn (Entra ID UPN)
Source

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

Get the display name.

Checks common claim names for user’s name:

  • name (most providers)
  • given_name + family_name fallback
Source

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

Get the tenant ID (handles different claim names across providers).

This method checks common claim names used by different OAuth providers:

  • tenant_id (normalized)
  • tid (Entra ID)
  • custom:tenant_id (Cognito custom attribute)
  • custom:tenant (Cognito custom attribute)
  • org_id (Auth0, Okta)
Source

pub fn groups(&self) -> Vec<String>

Get groups/roles the user belongs to.

Checks common claim names for group membership:

  • groups (Entra ID, Okta)
  • cognito:groups (Cognito)
  • roles (Auth0)
Source

pub fn has_scope(&self, scope: &str) -> bool

Check if the context has a specific scope.

Source

pub fn has_all_scopes(&self, scopes: &[&str]) -> bool

Check if the context has all specified scopes.

Source

pub fn has_any_scope(&self, scopes: &[&str]) -> bool

Check if the context has any of the specified scopes.

Source

pub fn require_scope(&self, scope: &str) -> Result<(), &'static str>

Require a scope, returning an error message if missing.

§Example
use pmcp::server::auth::AuthContext;

fn protected_operation(auth: &AuthContext) -> Result<(), &'static str> {
    auth.require_scope("write:data")?;
    // ... perform operation
    Ok(())
}
Source

pub fn require_auth(&self) -> Result<(), &'static str>

Require authentication, returning an error message if not authenticated.

§Example
use pmcp::server::auth::AuthContext;

fn protected_operation(auth: &AuthContext) -> Result<&str, &'static str> {
    auth.require_auth()?;
    Ok(auth.user_id())
}
Source

pub fn is_expired(&self) -> bool

Check if the token is expired.

Source

pub fn in_group(&self, group: &str) -> bool

Check if the user is in a specific group.

Trait Implementations§

Source§

impl Clone for AuthContext

Source§

fn clone(&self) -> AuthContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AuthContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AuthContext

Source§

fn default() -> AuthContext

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

impl<'de> Deserialize<'de> for AuthContext

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AuthContext

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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