Struct Gate 

pub struct Gate {
    pub provider: String,
    pub public_paths: Option<Vec<GatePath>>,
    pub session_ttl_secs: Option<u64>,
    pub base_path: Option<String>,
    pub cookie_name: Option<String>,
    pub forward_identity: Option<bool>,
}

A sign-in gate that inherits its identity from a namespace auth provider.

Every field but the provider is optional; one left None keeps what the deployment’s gate already has.

Fields

provider: String

The auth provider’s name in the deployment’s namespace: heyo, google, or one declared by hand.

public_paths: Option<Vec<GatePath>>

Path prefixes that skip sign-in, and what app-lb requires on them instead. Replaces the list when set.

session_ttl_secs: Option<u64>

How long a session lasts, in seconds.

base_path: Option<String>

Where the sign-in endpoints live under the deployment’s hostname. Default /__applb/auth; set it under the deployment’s path prefix if it is routed by one.

cookie_name: Option<String>

forward_identity: Option<bool>

Send the signed-in identity upstream as x-auth-request-* headers. On by default.

Implementations

impl Gate

pub fn provider(name: impl Into<String>) -> Self

pub fn public(self, prefix: impl Into<String>) -> Self

Let anyone reach paths under prefix without signing in.

pub fn path(self, prefix: impl Into<String>, scope: impl Into<String>) -> Self

Paths under prefix skip sign-in but need an app-token of scope.

pub fn session_ttl_secs(self, secs: u64) -> Self

pub fn base_path(self, path: impl Into<String>) -> Self

pub fn cookie_name(self, name: impl Into<String>) -> Self

pub fn forward_identity(self, on: bool) -> Self

pub fn apply_to(&self, spec: &mut Value) -> Result<()>

Write this gate onto spec’s auth block: the reference, the route-scoped fields that are set, and none of the inline identity fields, which app-lb refuses beside a reference.

Trait Implementations

impl Clone for Gate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gate

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

Formats the value using the given formatter.

impl Eq for Gate

impl PartialEq for Gate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Gate