Struct Authentication

#[non_exhaustive]
pub struct Authentication {
    pub rules: Vec<AuthenticationRule>,
    pub providers: Vec<AuthProvider>,
}

Authentication defines the authentication configuration for API methods provided by an API service.

Example:

name: calendar.googleapis.com
authentication:
  providers:
  - id: google_calendar_auth
    jwks_uri: https://www.googleapis.com/oauth2/v1/certs
    issuer: https://securetoken.google.com
  rules:
  - selector: "*"
    requirements:
      provider_id: google_calendar_auth
  - selector: google.calendar.Delegate
    oauth:
      canonical_scopes: https://www.googleapis.com/auth/calendar.read

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rules: Vec<AuthenticationRule>

A list of authentication rules that apply to individual API methods.

NOTE: All service configuration rules follow “last one wins” order.

providers: Vec<AuthProvider>

Defines a set of authentication providers that a service supports.

Implementations

impl Authentication

pub fn set_rules<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<AuthenticationRule>,

Sets the value of rules.

pub fn set_providers<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<AuthProvider>,

Sets the value of providers.

Trait Implementations

impl Clone for Authentication

fn clone(&self) -> Authentication

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Authentication

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

Formats the value using the given formatter.

impl Default for Authentication

fn default() -> Authentication

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Authentication

where Authentication: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Authentication

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Authentication

fn eq(&self, other: &Authentication) -> 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 Authentication

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Authentication