Skip to content

Commit 8ee50cb

Browse files
committed
Migrate internal links from /docs/auth to /docs/platform/auth
Update ~604 link references across ~111 MDX files to reflect the new canonical location of auth documentation under /platform/auth.
1 parent 631840d commit 8ee50cb

File tree

111 files changed

+604
-604
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+604
-604
lines changed

src/pages/docs/ai-transport/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ It also puts you in control of how you manage your application when there aren't
165165

166166
### Enterprise controls <a id="enterprise"/>
167167

168-
Ably's platform provides [integrations](/docs/platform/integrations) and functionality to ensure that your applications always exceed the requirements of enterprise environments. Whether that's [message auditing](/docs/platform/integrations/streaming), [client identification](/docs/auth/identified-clients) or [fine-grained authorization](/docs/auth/capabilities).
168+
Ably's platform provides [integrations](/docs/platform/integrations) and functionality to ensure that your applications always exceed the requirements of enterprise environments. Whether that's [message auditing](/docs/platform/integrations/streaming), [client identification](/docs/platform/auth/identified-clients) or [fine-grained authorization](/docs/platform/auth/capabilities).
169169

170170
## Examples
171171

src/pages/docs/ai-transport/messaging/citations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ The `multiple.v1` summary groups counts by the annotation `name`, with totals an
306306
```
307307
</Code>
308308

309-
When agents publish citations with a [`clientId`](/docs/auth/identified-clients), summaries include a per-client count showing how many citations each agent contributed. Citations published by [unidentified](/docs/auth/identified-clients#unidentified) clients are counted in the `totalUnidentified` field.
309+
When agents publish citations with a [`clientId`](/docs/platform/auth/identified-clients), summaries include a per-client count showing how many citations each agent contributed. Citations published by [unidentified](/docs/platform/auth/identified-clients#unidentified) clients are counted in the `totalUnidentified` field.
310310

311311
<Aside data-type="note">
312312
The `clipped` field indicates whether the summary was truncated due to size limits. This only occurs when a large number of clients with distinct `clientId`s publish annotations. See [large summaries](/docs/messages/annotations#large-summaries) for more information.

src/pages/docs/ai-transport/messaging/human-in-the-loop.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ channel.subscribe("approval-response", message -> {
330330
331331
### Verify by role <a id="verify-role"/>
332332
333-
Use [user claims](/docs/auth/capabilities#custom-restrictions-on-channels-) to embed roles directly in the JWT for role-based access control (RBAC). This approach is useful when permissions are role-based rather than user-specific, allowing you to make authorization decisions based on the user's role without looking up individual user permissions.
333+
Use [user claims](/docs/platform/auth/capabilities#custom-restrictions-on-channels-) to embed roles directly in the JWT for role-based access control (RBAC). This approach is useful when permissions are role-based rather than user-specific, allowing you to make authorization decisions based on the user's role without looking up individual user permissions.
334334
335335
<Aside data-type="note">
336336
This approach uses [authenticated claims for users](/docs/ai-transport/sessions-identity/identifying-users-and-agents#user-claims) to embed custom claims in JWTs that represent user roles or attributes.

src/pages/docs/ai-transport/sessions-identity/identifying-users-and-agents.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ In decoupled architectures, identity serves several critical purposes:
1717

1818
## Authenticating users <a id="authenticating"/>
1919

20-
Use [token authentication](/docs/auth/token) to authenticate users securely. Your authentication server generates a token that is signed with the secret part of your Ably API key. Clients use this token to connect to Ably, and the token signature ensures it cannot be tampered with.
20+
Use [token authentication](/docs/platform/auth/token) to authenticate users securely. Your authentication server generates a token that is signed with the secret part of your Ably API key. Clients use this token to connect to Ably, and the token signature ensures it cannot be tampered with.
2121

22-
The following examples use [JWT authentication](/docs/auth/token#jwt) for its simplicity and standard tooling support. For other approaches, see [token authentication](/docs/auth/token).
22+
The following examples use [JWT authentication](/docs/platform/auth/token#jwt) for its simplicity and standard tooling support. For other approaches, see [token authentication](/docs/platform/auth/token).
2323

2424
Create a server endpoint that generates signed JWTs after verifying user authentication:
2525

@@ -179,10 +179,10 @@ The `authenticateUser` middleware in this example is for demonstration purposes
179179

180180
The JWT is signed with the secret part of your Ably API key using [HMAC-SHA-256](https://datatracker.ietf.org/doc/html/rfc4868). This example does not embed any claims in the JWT payload, so by default the token inherits the capabilities of the Ably API key used to sign the token.
181181

182-
Configure your client to obtain a signed JWT from your server endpoint using an [`authCallback`](/docs/auth/token#auth-callback). The client obtains a signed JWT from the callback and uses it to authenticate requests to Ably. The client automatically makes a request for a new token before it expires.
182+
Configure your client to obtain a signed JWT from your server endpoint using an [`authCallback`](/docs/platform/auth/token#auth-callback). The client obtains a signed JWT from the callback and uses it to authenticate requests to Ably. The client automatically makes a request for a new token before it expires.
183183

184184
<Aside data-type="important">
185-
Never include your Ably API key in client code. Instead, always authenticate clients using [token auth](/docs/auth/token).
185+
Never include your Ably API key in client code. Instead, always authenticate clients using [token auth](/docs/platform/auth/token).
186186
</Aside>
187187

188188
<Code>
@@ -244,7 +244,7 @@ ably.connection.on(ConnectionState.connected, state -> {
244244

245245
## Authenticating agents <a id="authenticating-agents"/>
246246

247-
Agents typically run on servers in trusted environments where API keys can be securely stored. Use [API key authentication](/docs/auth#basic-authentication) to authenticate agents directly with Ably.
247+
Agents typically run on servers in trusted environments where API keys can be securely stored. Use [API key authentication](/docs/platform/auth#basic-authentication) to authenticate agents directly with Ably.
248248

249249
<Code>
250250
```javascript
@@ -287,12 +287,12 @@ Only use API key authentication in server-side code. Never include your Ably API
287287
</Aside>
288288

289289
<Aside data-type="note">
290-
Agents can also authenticate using [token authentication](/docs/auth/token), which is useful when agents run in environments where API keys should not be stored or when agents need dynamic capabilities that change based on runtime conditions.
290+
Agents can also authenticate using [token authentication](/docs/platform/auth/token), which is useful when agents run in environments where API keys should not be stored or when agents need dynamic capabilities that change based on runtime conditions.
291291
</Aside>
292292

293293
## Specifying capabilities <a id="capabilities"/>
294294

295-
Use [capabilities](/docs/auth/capabilities) to specify which operations clients can perform on which channels. This applies to both users and agents, allowing you to enforce fine-grained permissions.
295+
Use [capabilities](/docs/platform/auth/capabilities) to specify which operations clients can perform on which channels. This applies to both users and agents, allowing you to enforce fine-grained permissions.
296296

297297
### User capabilities <a id="user-capabilities"/>
298298

@@ -409,7 +409,7 @@ announcementsChannel.subscribe(msg -> System.out.println(msg)); // succeeds
409409
</Code>
410410

411411
<Aside data-type="note">
412-
Ably recommends using token authentication with short-lived tokens and minimal capabilities required for each user to limit the window of exposure if a token is compromised. For more information, see [When to use token auth](/docs/auth/token#when).
412+
Ably recommends using token authentication with short-lived tokens and minimal capabilities required for each user to limit the window of exposure if a token is compromised. For more information, see [When to use token auth](/docs/platform/auth/token#when).
413413
</Aside>
414414

415415
### Agent capabilities <a id="agent-capabilities"/>
@@ -479,12 +479,12 @@ Following the principle of least privilege, provision API keys with the minimum
479479

480480
Use the [`clientId`](/docs/messages#properties) to identify the user or agent that published a message. The method for setting `clientId` depends on your authentication approach:
481481

482-
- When using [basic authentication](/docs/auth/identified-clients#basic), specify the `clientId` directly in the client options when instantiating the client instance.
483-
- When using [token authentication](/docs/auth/identified-clients#token), specify an explicit `clientId` when issuing the token.
482+
- When using [basic authentication](/docs/platform/auth/identified-clients#basic), specify the `clientId` directly in the client options when instantiating the client instance.
483+
- When using [token authentication](/docs/platform/auth/identified-clients#token), specify an explicit `clientId` when issuing the token.
484484

485485
### User identity <a id="user-identity"/>
486486

487-
Users typically authenticate using [token authentication](/docs/auth/identified-clients#token). Add the [`x-ably-clientId`](/docs/api/realtime-sdk/authentication#ably-jwt) claim to your JWT to establish a verified identity for each user client. This identity appears as the [`clientId`](/docs/messages#properties) in all messages the user publishes, and subscribers can trust this identity because only your server can issue JWTs with specific `clientId` values.
487+
Users typically authenticate using [token authentication](/docs/platform/auth/identified-clients#token). Add the [`x-ably-clientId`](/docs/api/realtime-sdk/authentication#ably-jwt) claim to your JWT to establish a verified identity for each user client. This identity appears as the [`clientId`](/docs/messages#properties) in all messages the user publishes, and subscribers can trust this identity because only your server can issue JWTs with specific `clientId` values.
488488

489489
As with all clients, the method for setting `clientId` depends on your [authentication approach](#identity).
490490

@@ -608,7 +608,7 @@ The `clientId` in the message can be trusted, so agents can use this identity to
608608

609609
### Agent identity <a id="agent-identity"/>
610610

611-
Agent code typically runs in a trusted environment, so you can use [basic authentication](/docs/auth/identified-clients#basic) and directly specify the `clientId` when instantiating the agent client. This identity appears as the [`clientId`](/docs/messages#properties) in all messages the agent publishes, allowing subscribers to identify the agent which published a message.
611+
Agent code typically runs in a trusted environment, so you can use [basic authentication](/docs/platform/auth/identified-clients#basic) and directly specify the `clientId` when instantiating the agent client. This identity appears as the [`clientId`](/docs/messages#properties) in all messages the agent publishes, allowing subscribers to identify the agent which published a message.
612612

613613
<Code>
614614
```javascript
@@ -681,7 +681,7 @@ channel.subscribe(message -> {
681681
</Code>
682682

683683
<Aside data-type="note">
684-
Agents can also authenticate using [token authentication](/docs/auth/token), which is useful when agents run in environments where API keys cannot be accessed securely or when agents need [dynamic capabilities](/docs/auth/token#dynamic-channel-access-control).
684+
Agents can also authenticate using [token authentication](/docs/platform/auth/token), which is useful when agents run in environments where API keys cannot be accessed securely or when agents need [dynamic capabilities](/docs/platform/auth/token#dynamic-channel-access-control).
685685
</Aside>
686686

687687
## Adding roles and attributes <a id="roles-attributes"/>
@@ -690,7 +690,7 @@ Embed custom roles and attributes in messages to enable role-based access contro
690690

691691
### User claims <a id="user-claims"/>
692692

693-
Use [authenticated claims for users](/docs/auth/capabilities#custom-restrictions-on-channels-) to embed custom claims in JWTs that represent user roles or attributes.
693+
Use [authenticated claims for users](/docs/platform/auth/capabilities#custom-restrictions-on-channels-) to embed custom claims in JWTs that represent user roles or attributes.
694694

695695
Add claims with names matching the `ably.channel.*` pattern to your JWT to specify user claims for specific channels. Claims can be scoped to individual channels or to [namespaces](/docs/channels#namespaces) of channels. The most specific user claim matching the channel is automatically included under `extras.userClaim` in all messages the client publishes.
696696

src/pages/docs/ai-transport/sessions-identity/online-status.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For details on authenticating users and agents and setting the `clientId`, see [
2626
You have flexibility in when to enter presence. For example, an agent might choose to appear as online only while processing a specific task, or remain present for the duration of the entire session. Users typically enter presence when they connect to a session and remain present until they disconnect.
2727

2828
<Aside data-type="note">
29-
Clients require the [`presence`](/docs/auth/capabilities) capability on the channel to participate in presence.
29+
Clients require the [`presence`](/docs/platform/auth/capabilities) capability on the channel to participate in presence.
3030
</Aside>
3131

3232
For example, a user client can enter presence when joining a session:
@@ -98,7 +98,7 @@ channel.presence.enter(data);
9898

9999
### Going online from multiple devices <a id="multiple-devices"/>
100100

101-
A single user can be present on a channel from multiple devices simultaneously. Ably tracks each connection separately using a unique [`connectionId`](/docs/connect#connection-ids), while maintaining the same [`clientId`](/docs/auth/identified-clients#assign) across all connections.
101+
A single user can be present on a channel from multiple devices simultaneously. Ably tracks each connection separately using a unique [`connectionId`](/docs/connect#connection-ids), while maintaining the same [`clientId`](/docs/platform/auth/identified-clients#assign) across all connections.
102102

103103
When a user connects from multiple devices, each device enters presence independently. All connections share the same `clientId` but have different `connectionId` values.
104104

@@ -360,7 +360,7 @@ AblyRealtime ably = new AblyRealtime(options);
360360
Participants in a session can query the current presence set or subscribe to presence events to see who else is online and react to changes in realtime. Users might want to see which agents are processing work, while agents might want to detect when specific users are offline to pause or cancel work.
361361

362362
<Aside data-type="note">
363-
Clients require the `subscribe` [capability](/docs/auth/capabilities) on the channel to retrieve the presence set and subscribe to presence events.
363+
Clients require the `subscribe` [capability](/docs/platform/auth/capabilities) on the channel to retrieve the presence set and subscribe to presence events.
364364
</Aside>
365365

366366
### Retrieving current presence members <a id="get-members"/>

src/pages/docs/ai-transport/sessions-identity/push-notifications.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Push notification setup is platform-specific. See the following guides to config
3131
</Aside>
3232

3333
<Aside data-type="note">
34-
To send push notifications to a specific user's devices rather than to channel subscribers, the agent's token requires the `push-admin` [capability](/docs/auth/capabilities). This enables direct publishing via the Push Admin API.
34+
To send push notifications to a specific user's devices rather than to channel subscribers, the agent's token requires the `push-admin` [capability](/docs/platform/auth/capabilities). This enables direct publishing via the Push Admin API.
3535
</Aside>
3636

3737
## Opt-in patterns <a id="opt-in"/>

src/pages/docs/ai-transport/sessions-identity/resuming-sessions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Ably provides access to channel message history, enabling agents to retrieve any
5959
When an agent resumes, it needs to retrieve messages published while it was offline. Use [channel history](/docs/storage-history/history) with the [`untilAttach` option](/docs/storage-history/history#continuous-history) to catch up on historical messages while preserving continuity with live message delivery.
6060

6161
<Aside data-type="note">
62-
Clients require the [`history`](/docs/auth/capabilities) capability on the channel to retrieve message history.
62+
Clients require the [`history`](/docs/platform/auth/capabilities) capability on the channel to retrieve message history.
6363
</Aside>
6464

6565
#### Persisted session state

src/pages/docs/ai-transport/token-streaming/message-per-response.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To enable the channel rule:
4141

4242
The examples on this page use the `ai:` namespace prefix, which assumes you have configured the rule for `ai`.
4343

44-
Your token or API key needs the following [capabilities](/docs/auth/capabilities) on the channel:
44+
Your token or API key needs the following [capabilities](/docs/platform/auth/capabilities) on the channel:
4545

4646
| Capability | Purpose |
4747
| --- | --- |

0 commit comments

Comments
 (0)