ably_auth_openapi/models/
token_request.rs

1/*
2 * Ably Platform Auth REST API
3 *
4 * The subset of the Ably **platform** REST API used for authentication and token lifecycle: requesting Ably Tokens, revoking them, and reading server time. This is a *separate* API from the Ably Chat REST API (`openapi/ably-chat-rest.yaml`, path prefix `/chat/v4`) — token issuance and revocation live on the platform host under `/keys/...`, not under `/chat/_*`.  ## Scope & provenance Ably publishes an authoritative platform spec, [`ably/open-specs`](https://github.com/ably/open-specs) `platform-v1.yaml`, which covers the full generic pub/sub REST API (`/channels`, `/push`, `/keys`, `/stats`, `/time`). **This document is deliberately narrow**: it models only the endpoints this project's authentication story ([ADR-0012](../docs/adr/0012-token-issuance-permissions.md), [SPEC §13](../docs/SPEC.md)) touches — `POST /keys/{keyName}/requestToken`, `POST /keys/{keyName}/revokeTokens`, and `GET /time`. Field-level details are cross-checked against `platform-v1.yaml`, the Ably auth docs, and the `ably-js` auth implementation (see [`../docs/research/2026-07-24-ably-chat-auth-permissions.md`](../docs/research/2026-07-24-ably-chat-auth-permissions.md)).  ## Relationship to the Chat client `ably-chat-rs` is a Chat REST client; it does not itself sign TokenRequests or call `/keys/...` (ADR-0012 Tier 4). This spec documents the platform endpoints a *token server* (or the official `ably` crate) uses to mint the Bearer credentials that are then handed to the Chat client. Capability documents carried by these tokens are described in SPEC §13, not here. 
5 *
6 * The version of the OpenAPI document: 1.0.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// TokenRequest : A **signed** token request. The `mac` is HMAC-SHA256 (base64) over the newline-joined fields `keyName`, `ttl`, `capability`, `clientId`, `timestamp`, `nonce` (each followed by a newline, empty fields included) using the API key secret. A signed request needs no `Authorization` header. 
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct TokenRequest {
17    /// The API key name (`appId.keyId`) that signed this request.
18    #[serde(rename = "keyName")]
19    pub key_name: String,
20    /// Requested time-to-live in milliseconds.
21    #[serde(rename = "ttl", skip_serializing_if = "Option::is_none")]
22    pub ttl: Option<i64>,
23    /// A capability document as a JSON **string** (a stringified object mapping resource-name patterns to arrays of operations, e.g. `{\"my-room\":[\"publish\",\"history\"]}`). For a signed `TokenRequest` this string must be canonicalized (resource keys and operation arrays sorted, no whitespace) because it is part of the HMAC-signed text. See SPEC §13. 
24    #[serde(rename = "capability", skip_serializing_if = "Option::is_none")]
25    pub capability: Option<String>,
26    /// The identity to bind the token to.
27    #[serde(rename = "clientId", skip_serializing_if = "Option::is_none")]
28    pub client_id: Option<String>,
29    /// Milliseconds since the Unix epoch when the request was created. Must be within ~2 minutes of Ably server time (see `GET /time`). 
30    #[serde(rename = "timestamp")]
31    pub timestamp: i64,
32    /// An opaque, cryptographically-random string of at least 16 characters, unique per request (replay protection). 
33    #[serde(rename = "nonce")]
34    pub nonce: String,
35    /// Base64 HMAC-SHA256 signature over the canonical request text.
36    #[serde(rename = "mac")]
37    pub mac: String,
38}
39
40impl TokenRequest {
41    /// A **signed** token request. The `mac` is HMAC-SHA256 (base64) over the newline-joined fields `keyName`, `ttl`, `capability`, `clientId`, `timestamp`, `nonce` (each followed by a newline, empty fields included) using the API key secret. A signed request needs no `Authorization` header. 
42    pub fn new(key_name: String, timestamp: i64, nonce: String, mac: String) -> TokenRequest {
43        TokenRequest {
44            key_name,
45            ttl: None,
46            capability: None,
47            client_id: None,
48            timestamp,
49            nonce,
50            mac,
51        }
52    }
53}
54
ably_auth_openapi/models/token_request.rs

ably_auth_openapi/models/
token_request.rs
