diff options
Diffstat (limited to 'docs/api/invitations.md')
| -rw-r--r-- | docs/api/invitations.md | 102 |
1 files changed, 56 insertions, 46 deletions
diff --git a/docs/api/invitations.md b/docs/api/invitations.md index 1839ef5..0be2c2e 100644 --- a/docs/api/invitations.md +++ b/docs/api/invitations.md @@ -21,9 +21,9 @@ sequenceDiagram API -->>- Blake : Success ``` -Other than the login created during [initial setup](./initial-setup.md), new logins can only be created by using invitations. +Other than the user created during [initial setup](./initial-setup.md), new users can only be created by using invitations. -Any login can create invitations. Each invitation can be accepted at most once. An invitation which is not accepted within 24 hours expires. +Any user can create invitations. Each invitation can be accepted at most once. An invitation which is not accepted within 24 hours expires. ## `POST /api/invite` @@ -40,25 +40,27 @@ The request must be an empty JSON object. ### Success -This endpoint will respond with a status of `200 Okay` when successful. The body of the response will be a JSON object describing the new invitation: +This endpoint will respond with a status of +`200 Okay` when successful. The body of the response will be a JSON object describing the new invitation: ```json { - "id": "I3884", - "issuer": "Labcd1234", - "issued_at": "2024-10-12T01:43:12.001853Z" + "id": "I3884", + "issuer": "Uabcd1234", + "issued_at": "2024-10-12T01:43:12.001853Z" } ``` The response will include the following fields: -| Field | Type | Description | -|:------------|:-------|:--| +| Field | Type | Description | +|:------------|:-------|:------------------------------------------------------------------------------| | `id` | string | A unique identifier for the invitation. This ID must be given to the invitee. | -| `issuer` | string | The login ID of the invitation's issuer. | -| `issued_at` | string | The timestamp from which the invitation will expire. | +| `issuer` | string | The user ID of the invitation's issuer. | +| `issued_at` | string | The timestamp from which the invitation will expire. | -Clients and their operators are responsible for delivering the invitation to the invitee. Clients are strongly recommended to construct a URL for the invitation so that the invitee can take action on it easily. The included client supports URLs of the format `https://example.net/invite/:id` (with the `:id` placeholder substituted with the invitation's ID). +Clients and their operators are responsible for delivering the invitation to the invitee. Clients are strongly recommended to construct a URL for the invitation so that the invitee can take action on it easily. The included client supports URLs of the format +`https://example.net/invite/:id` (with the `:id` placeholder substituted with the invitation's ID). ## `GET /api/invite/:id` @@ -67,50 +69,53 @@ Returns information about an outstanding invitation. This endpoint requires the following path parameter: -| Parameter | Type | Description | -|:----------|:-------|:--| -| `id` | string | An invitation ID, as returned from a previous request to `POST /api/invite`. | +| Parameter | Type | Description | +|:----------|:-------|:-----------------------------------------------------------------------------| +| `id` | string | An invitation ID, as returned from a previous request to `POST /api/invite`. | **This endpoint does not require an `identity` cookie.** ### On success -This endpoint will respond with a status of `200 Okay` when successful. The body of the response will be a JSON object describing the invitation: +This endpoint will respond with a status of +`200 Okay` when successful. The body of the response will be a JSON object describing the invitation: ```json { - "issuer": { - "id": "Labcd1234", - "name": "i send you invites" - }, - "issued_at": "2024-10-12T01:43:12.001853Z" + "issuer": { + "id": "Uabcd1234", + "name": "i send you invites" + }, + "issued_at": "2024-10-12T01:43:12.001853Z" } ``` The response will include the following fields: -| Field | Type | Description | -|:------------|:-------|:--| -| `id` | string | The ID of the invitation. | -| `issuer` | string | The login name of the invitation's issuer. | +| Field | Type | Description | +|:------------|:-------|:-----------------------------------------------------| +| `id` | string | The ID of the invitation. | +| `issuer` | string | The name of the invitation's issuer. | | `issued_at` | string | The timestamp from which the invitation will expire. | -Clients should present the `issuer` to the user when presenting an invitation, so as to personalize the invitation and help them understand their connection with the service. +Clients should present the +`issuer` to the user when presenting an invitation, so as to personalize the invitation and help them understand their connection with the service. ### Invitation not found -This endpoint will respond with a status of `404 Not Found` when the invitation ID either does not exist, or has already been accepted. +This endpoint will respond with a status of +`404 Not Found` when the invitation ID either does not exist, or has already been accepted. ## `POST /api/invite/:id` -Accepts an invitation and creates a new login. +Accepts an invitation and creates a new user. This endpoint requires the following path parameter: -| Parameter | Type | Description | -|:----------|:-------|:--| -| `id` | string | An invitation ID, as returned from a previous request to `POST /api/invite`. | +| Parameter | Type | Description | +|:----------|:-------|:-----------------------------------------------------------------------------| +| `id` | string | An invitation ID, as returned from a previous request to `POST /api/invite`. | **This endpoint does not require an `identity` cookie.** @@ -118,17 +123,17 @@ This endpoint requires the following path parameter: ```json { - "name": "example login", - "password": "correct-horse-battery-staple" + "name": "example user", + "password": "correct-horse-battery-staple" } ``` The request must have the following fields: -| Field | Type | Description | -|:-----------|:-------|:--| -| `name` | string | The new login's name. | -| `password` | string | The new login's password, in plain text. | +| Field | Type | Description | +|:-----------|:-------|:----------------------------------------| +| `name` | string | The new user's name. | +| `password` | string | The new user's password, in plain text. | <!-- Reproduced in initial-setup.md. Edit in both places. --> The proposed `name` must be valid. The precise definition of valid is still up in the air, but, at minimum: @@ -143,40 +148,45 @@ The proposed `name` must be valid. The precise definition of valid is still up i <!-- This prose is duplicated from authentication.md, with small changes for context. If you edit it here, edit it there, too. --> -This endpoint will respond with a status of `200 Okay` when successful. The body of the response will be a JSON object describing the newly-created login: +This endpoint will respond with a status of +`200 Okay` when successful. The body of the response will be a JSON object describing the newly-created user: ```json { - "id": "Labcd1234", - "name": "Andrea" + "id": "Uabcd1234", + "name": "Andrea" } ``` The response will include the following fields: -| Field | Type | Description | -|:------------|:-------|:--| -| `id` | string | A unique identifier for the newly-created login. This can be used to associate the login with other events, or to make API calls targeting the login. | -| `name` | string | The login's name. | +| Field | Type | Description | +|:-------|:-------|:---------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | string | A unique identifier for the newly-created user. This can be used to associate the user with other events, or to make API calls targeting the user. | +| `name` | string | The user's name. | The returned name may not be identical to the name requested, as the name will be converted to [normalization form C](http://www.unicode.org/reports/tr15/) automatically. The returned name will include this normalization; the service will use the normalized name elsewhere, and does not store the originally requested name. The provided password will also be converted to normalization form C. However, the normalized password is not returned to the client. -The response will include a `Set-Cookie` header for the `identity` cookie, providing the client with a newly-minted identity token associated with the login created for this request. See the [authentication](./authentication.md) section for details on how this cookie may be used. +The response will include a `Set-Cookie` header for the +`identity` cookie, providing the client with a newly-minted identity token associated with the login created for this request. See the [authentication](./authentication.md) section for details on how this cookie may be used. The cookie will expire if it is not used regularly. ### Invitation not found -This endpoint will respond with a status of `404 Not Found` when the invitation ID either does not exist, or has already been accepted. +This endpoint will respond with a status of +`404 Not Found` when the invitation ID either does not exist, or has already been accepted. ### Name not valid This endpoint will respond with a status of `400 Bad Request` if the proposed `name` is not valid. +The invitation can be accepted with a different name. + ### Name in use -This endpoint will respond with a status of `409 Conflict` if the requested login name has already been taken. +This endpoint will respond with a status of `409 Conflict` if the requested `name` has already been taken. The invitation can be accepted with a different name. |