Struct KeyCreateParams 

pub struct KeyCreateParams {
    pub key_type: Option<String>,
    pub description: Option<String>,
    pub capabilities: Option<Value>,
    pub expiry_seconds: Option<i64>,
    pub scopes: Option<Vec<String>>,
    pub tags: Option<Vec<String>>,
    pub issuer: Option<String>,
    pub subject: Option<String>,
    pub audience: Option<String>,
    pub custom_claim_rules: Option<BTreeMap<String, String>>,
}

Fields

key_type: Option<String>

auth for a device registration key, client for an OAuth client, federated for a federated identity. Omit it and the control plane creates an auth key (Q80).

description: Option<String>

Up to 50 characters of letters, digits, hyphens and spaces.

capabilities: Option<Value>

Auth keys: what registering with this key produces, in Tailscale’s own shape — {"devices": {"create": {"reusable": true, "ephemeral": false, "preauthorized": true, "tags": ["tag:example"]}}}. Sent as written.

expiry_seconds: Option<i64>

Auth keys: how long the key stays usable, in seconds.

scopes: Option<Vec<String>>

OAuth clients and federated identities: what tokens minted from this credential may do, as auth_keys or devices:core:read.

tags: Option<Vec<String>>

The tags this credential may act as. Required when scopes includes devices:core or auth_keys.

issuer: Option<String>

Federated identities: the issuer whose JWTs are accepted.

subject: Option<String>

Federated identities: the subject a JWT must claim.

audience: Option<String>

Federated identities: the audience a JWT must claim.

custom_claim_rules: Option<BTreeMap<String, String>>

Federated identities: claims mapped to the values they must have.

Trait Implementations

impl Debug for KeyCreateParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyCreateParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for KeyCreateParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.