ably_auth_openapi/models/
token_params.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/// TokenParams : An **unsigned** token request. Sent with HTTP Basic auth; Ably signs the token server-side. To request all of the key's capabilities, omit `capability`. 
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct TokenParams {
17    /// Requested time-to-live in milliseconds. Defaults to 3600000 (1 hour) when omitted. Tokens from a revocable-tokens key are capped at 1 hour. 
18    #[serde(rename = "ttl", skip_serializing_if = "Option::is_none")]
19    pub ttl: Option<i64>,
20    /// 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. 
21    #[serde(rename = "capability", skip_serializing_if = "Option::is_none")]
22    pub capability: Option<String>,
23    /// The identity to bind the token to. The resulting token may only act as this `clientId`; `*` grants the privileged wildcard identity. 
24    #[serde(rename = "clientId", skip_serializing_if = "Option::is_none")]
25    pub client_id: Option<String>,
26}
27
28impl TokenParams {
29    /// An **unsigned** token request. Sent with HTTP Basic auth; Ably signs the token server-side. To request all of the key's capabilities, omit `capability`. 
30    pub fn new() -> TokenParams {
31        TokenParams {
32            ttl: None,
33            capability: None,
34            client_id: None,
35        }
36    }
37}
38
ably_auth_openapi/models/token_params.rs

ably_auth_openapi/models/
token_params.rs
