Struct Entitlements 

#[non_exhaustive]
pub struct Entitlements {
    pub applications: Vec<ApplicationEntitlements>,
    pub certificates: Vec<HeldCertificate>,
    pub domains: Vec<String>,
    pub may_manage_dns: bool,
    pub may_manage_tls: bool,
    pub paused: bool,
    pub registered_names: Vec<String>,
}

What a server is entitled to do with names, and what it already holds.

JSON schema

{
 "description": "What a server is entitled to do with names, and what it already holds.",
 "type": "object",
 "required": [
   "certificates",
   "domains",
   "may_manage_dns",
   "may_manage_tls",
   "paused",
   "registered_names"
 ],
 "properties": {
   "applications": {
     "description": "One entry per application on the asking machine.\n\nAn identity belongs to a machine, so an agent asks on behalf of the box\nand gets an answer for every workload on it. The flat fields above\ndescribe a single-application machine, which is every machine today;\non a machine hosting several they are left at their defaults and this\nlist is the answer.",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/ApplicationEntitlements"
     }
   },
   "certificates": {
     "description": "The certificates Canopy holds for this server.",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/HeldCertificate"
     }
   },
   "domains": {
     "description": "The domains this server's group controls. Any name at or beneath one of\nthese is a name this server may act on — which is what lets an agent\nrequest a certificate before anything asks for one.",
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "may_manage_dns": {
     "description": "Whether this server may manage its own DNS records.",
     "type": "boolean"
   },
   "may_manage_tls": {
     "description": "Whether this server may obtain its own TLS certificates.",
     "type": "boolean"
   },
   "paused": {
     "description": "Whether Canopy is currently making no new changes on this server's\nbehalf. While true, requests are refused and an agent should wait.",
     "type": "boolean"
   },
   "registered_names": {
     "description": "The names this server has registered addresses for.",
     "type": "array",
     "items": {
       "type": "string"
     }
   }
 }
}

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.

applications: Vec<ApplicationEntitlements>

One entry per application on the asking machine.

An identity belongs to a machine, so an agent asks on behalf of the box and gets an answer for every workload on it. The flat fields above describe a single-application machine, which is every machine today; on a machine hosting several they are left at their defaults and this list is the answer.

certificates: Vec<HeldCertificate>

The certificates Canopy holds for this server.

domains: Vec<String>

The domains this server’s group controls. Any name at or beneath one of these is a name this server may act on — which is what lets an agent request a certificate before anything asks for one.

may_manage_dns: bool

Whether this server may manage its own DNS records.

may_manage_tls: bool

Whether this server may obtain its own TLS certificates.

paused: bool

Whether Canopy is currently making no new changes on this server’s behalf. While true, requests are refused and an agent should wait.

registered_names: Vec<String>

The names this server has registered addresses for.

Implementations

impl Entitlements

pub fn builder() -> EntitlementsBuilder

Create an instance of Entitlements using the builder syntax

Trait Implementations

impl Clone for Entitlements

fn clone(&self) -> Entitlements

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entitlements

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entitlements

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Entitlements

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

where __S: Serializer,

Serialize this value into the given Serde serializer.