Struct Key 

pub struct Key {

    pub id: Option<String>,
    pub key: Option<Secret>,
    pub key_type: Option<String>,
    pub expiry_seconds: Option<i64>,
    pub created: Option<String>,
    pub updated: Option<String>,
    pub expires: Option<String>,
    pub revoked: Option<String>,
    pub capabilities: Option<KeyCapabilities>,
    pub scopes: Option<Vec<String>>,
    pub tags: Option<Vec<String>>,
    pub description: Option<String>,
    pub invalid: Option<bool>,
    pub user_id: Option<String>,
    pub audience: Option<String>,
    pub issuer: Option<String>,
    pub subject: Option<String>,
    pub custom_claim_rules: Option<BTreeMap<String, String>>,
    pub unknown: Unknown,
}

An auth key, an API access token, an OAuth client or a federated identity.

Fields

id: Option<String>

key: Option<Secret>

The secret itself, sent only in the answer that creates it. There is no second chance to read it.

key_type: Option<String>

One of KEY_TYPES.

expiry_seconds: Option<i64>

Auth keys only.

created: Option<String>

updated: Option<String>

expires: Option<String>

revoked: Option<String>

capabilities: Option<KeyCapabilities>

scopes: Option<Vec<String>>

OAuth clients and federated identities: what the tokens they mint are allowed to do.

tags: Option<Vec<String>>

description: Option<String>

invalid: Option<bool>

user_id: Option<String>

audience: Option<String>

Federated identities: the audience the JWT must claim.

issuer: Option<String>

Federated identities: the issuer whose JWTs are accepted.

subject: Option<String>

Federated identities: the subject the JWT must claim.

custom_claim_rules: Option<BTreeMap<String, String>>

Federated identities: claims mapped to values, for narrowing which JWTs from the issuer are accepted.

unknown: Unknown

Everything the description did not mention, kept so that a control plane ahead of this build still answers usefully.

Implementations

impl Key

pub const SCHEMA: &'static str

The path the vendored description reaches this by.

pub const FIELDS: &'static [&'static str]

The JSON names of the fields above, in declaration order. Not the Rust names.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Key

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Key

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 Key