Struct EngineDoc 

pub struct EngineDoc {
    pub provider: String,
    pub mechanism: String,
    pub shape: CredentialShape,
    pub revocable: bool,
    pub revoke_effect: String,
    pub ttl: TtlDoc,
    pub scoping: String,
    pub root_credential: String,
    pub paths: Vec<PathDoc>,
    pub docs_url: Option<String>,
    pub caveats: Vec<String>,
}

Everything an operator or a consumer needs to know about an engine without leaving the API: which provider, which mechanism, what a lease is worth, what revoke() really does, and what the server had to be trusted with.

Served at GET /v1/{mount}/help, and its operative fields are echoed in the _doc block of every credential response.

Fields

provider: String

mechanism: String

The concrete provider API being used, e.g. “GitHub App installation tokens”.

shape: CredentialShape

revocable: bool

Whether revoking a lease destroys the credential the consumer holds. Must agree with shape.revocable() — the server asserts this, because an engine that overstates it would mislead every caller.

revoke_effect: String

What revoke() does in reality — including “nothing, the credential keeps working until it expires”, which is the truth for three of the providers here and must not be dressed up.

ttl: TtlDoc

scoping: String

root_credential: String

What long-lived secret the server must hold, or “none” under federation.

paths: Vec<PathDoc>

docs_url: Option<String>

caveats: Vec<String>

Sharp edges worth knowing before depending on this engine.

Trait Implementations

impl Clone for EngineDoc

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 EngineDoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EngineDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EngineDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.