Skip to content

Commit 07b94b5

Browse files
committed
add updating documentation
1 parent be1f6c6 commit 07b94b5

2 files changed

Lines changed: 36 additions & 1 deletion

File tree

docs/deploying-aggregators.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
This document will show how to deploy an Aggregator on a running Aggregator Server.
44

5-
Seting up an aggregator is done using the endpoint advocated with `registration_endpoint` at the discovery endpoint. The rest of this document assumes this endpoint is at `/registration`.
5+
Setting up an aggregator is done using the endpoint advocated with `registration_endpoint` at the discovery endpoint. The rest of this document assumes this endpoint is at `/registration`.
6+
7+
Updating an existing aggregator is done by including the `aggregator_id` field in any registration request. See [Updating Aggregators](updating-aggregators.md) for more details.
68

79
## Device Code Flow
810

docs/updating-aggregators.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Updating Aggregators
2+
3+
Aggregators authenticate on behalf of a user using a long-lived refresh token obtained during registration. These refresh tokens do not last indefinitely — they expire based on the Identity Provider's session and token lifetime policies.
4+
5+
When a refresh token expires, the aggregator can no longer act on behalf of the user and must be updated to issue a new one.
6+
7+
## Update Flow
8+
9+
To update an existing aggregator, repeat any registration flow as defined in [Deploying Aggregators](deploying-aggregators.md), adding the `aggregator_id` of the aggregator to update:
10+
11+
```http
12+
POST /registration
13+
Content-Type: application/json
14+
15+
{
16+
"registration_type": "<device_code | token_exchange>",
17+
"aggregator_id": "<aggregator-id>"
18+
}
19+
```
20+
21+
The aggregator server will verify that the authenticated user owns the specified aggregator before issuing a new refresh token.
22+
23+
### Additional Responses
24+
25+
In addition to the standard responses described in [Deploying Aggregators](deploying-aggregators.md), the following responses may be returned:
26+
27+
**403 Forbidden**
28+
29+
Returned if the authenticated user does not own the specified aggregator.
30+
31+
**404 Not Found**
32+
33+
Returned if the specified `aggregator_id` does not exist.

0 commit comments

Comments
 (0)