Struct BeginArgs 

#[non_exhaustive]
pub struct BeginArgs {
    pub server_id: Uuid,
    pub spki: Option<String>,
    pub token: String,
}

Request to start device enrollment against a machine.

JSON schema

{
 "description": "Request to start device enrollment against a machine.",
 "type": "object",
 "required": [
   "server_id",
   "token"
 ],
 "properties": {
   "server_id": {
     "description": "ID of the machine to enroll against. Named `server_id` because that is\nthe name fielded agents send; the value has always identified the box.",
     "type": "string",
     "format": "uuid"
   },
   "spki": {
     "description": "Base64-standard-encoded DER SubjectPublicKeyInfo (SPKI) of the\ndevice's public key. Only required when enrolling over a transport\nwith no client certificate to read the key from (e.g. over\nTailscale); omit it when enrolling over mTLS, where the key is\ntaken from the presented client certificate. The returned challenge\nis bound to this key, so the same value must be supplied again when\ncompleting enrollment.",
     "type": [
       "string",
       "null"
     ]
   },
   "token": {
     "description": "The enrollment token issued by an operator for this machine.",
     "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.

server_id: Uuid

ID of the machine to enroll against. Named server_id because that is the name fielded agents send; the value has always identified the box.

spki: Option<String>

Base64-standard-encoded DER SubjectPublicKeyInfo (SPKI) of the device’s public key. Only required when enrolling over a transport with no client certificate to read the key from (e.g. over Tailscale); omit it when enrolling over mTLS, where the key is taken from the presented client certificate. The returned challenge is bound to this key, so the same value must be supplied again when completing enrollment.

token: String

The enrollment token issued by an operator for this machine.

Implementations

impl BeginArgs

pub fn builder() -> BeginArgsBuilder

Create an instance of BeginArgs using the builder syntax

Trait Implementations

impl Clone for BeginArgs

fn clone(&self) -> BeginArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BeginArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BeginArgs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BeginArgs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.