Skip to main content

ProtectedResourceMetadata

Struct ProtectedResourceMetadata 

Source
pub struct ProtectedResourceMetadata {
Show 13 fields pub resource: String, pub resource_name: Option<String>, pub authorization_servers: Option<Vec<String>>, pub jwks_uri: Option<String>, pub scopes_supported: Option<Vec<String>>, pub bearer_methods_supported: Option<Vec<String>>, pub resource_signing_alg_values_supported: Option<Vec<String>>, pub resource_encryption_alg_values_supported: Option<Vec<String>>, pub resource_encryption_enc_values_supported: Option<Vec<String>>, pub resource_documentation: Option<String>, pub resource_policy_uri: Option<String>, pub resource_tos_uri: Option<String>, pub required: Option<bool>,
}
Expand description

Describes a protected resource’s authentication requirements using RFC 9728 (OAuth 2.0 Protected Resource Metadata) semantics.

Field names use snake_case to match the RFC 9728 JSON format.

Fields§

§resource: String

REQUIRED. The protected resource’s resource identifier, a URL using the https scheme with no fragment component (e.g. "https://api.github.com").

§resource_name: Option<String>

OPTIONAL. Human-readable name of the protected resource.

§authorization_servers: Option<Vec<String>>

OPTIONAL. JSON array of OAuth authorization server identifier URLs.

§jwks_uri: Option<String>

OPTIONAL. URL of the protected resource’s JWK Set document.

§scopes_supported: Option<Vec<String>>

RECOMMENDED. JSON array of OAuth 2.0 scope values used in authorization requests.

§bearer_methods_supported: Option<Vec<String>>

OPTIONAL. JSON array of Bearer Token presentation methods supported.

§resource_signing_alg_values_supported: Option<Vec<String>>

OPTIONAL. JSON array of JWS signing algorithms supported.

§resource_encryption_alg_values_supported: Option<Vec<String>>

OPTIONAL. JSON array of JWE encryption algorithms (alg) supported.

§resource_encryption_enc_values_supported: Option<Vec<String>>

OPTIONAL. JSON array of JWE encryption algorithms (enc) supported.

§resource_documentation: Option<String>

OPTIONAL. URL of human-readable documentation for the resource.

§resource_policy_uri: Option<String>

OPTIONAL. URL of the resource’s data-usage policy.

§resource_tos_uri: Option<String>

OPTIONAL. URL of the resource’s terms of service.

§required: Option<bool>

AHP extension. Whether authentication is required for this resource.

  • true (default) — the agent cannot be used without a valid token. The server SHOULD return AuthRequired (-32007) if the client attempts to use the agent without authenticating.
  • false — the agent works without authentication but MAY offer enhanced capabilities when a token is provided.

Clients SHOULD treat an absent field the same as true.

Trait Implementations§

Source§

impl Clone for ProtectedResourceMetadata

Source§

fn clone(&self) -> ProtectedResourceMetadata

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 ProtectedResourceMetadata

Source§

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

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

impl<'de> Deserialize<'de> for ProtectedResourceMetadata

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 PartialEq for ProtectedResourceMetadata

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for ProtectedResourceMetadata

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
Source§

impl StructuralPartialEq for ProtectedResourceMetadata

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.