ProtectedEndpoint

Device-scoped operations that require the registered device's authentication. Each one fixes the HTTP method and the canonical path the signature must cover (docs/server-authentication.md).

Entries

Link copied to clipboard

PUT /v1/devices/{user}/{device}/prekeys

Link copied to clipboard

GET /v1/devices/{user}/{device}/messages

Link copied to clipboard

GET /v1/devices/{user}/{device}/registration: the device's own registration state.

Link copied to clipboard

PUT /v1/devices/{user}/{device}/last-device-recovery/key: registers the user's last-device recovery key.

Link copied to clipboard

GET /v1/devices/{user}/{device}/last-device-recovery/key: the user's recovery key state (docs/recovery-key-lifecycle.md).

Link copied to clipboard

PUT /v1/devices/{user}/{device}/last-device-recovery/key/rotation: rotates the user's recovery key.

Link copied to clipboard

PUT /v1/devices/{user}/{device}/last-device-recovery/key/revocation: revokes the user's recovery key.

Link copied to clipboard

PUT /v1/devices/{user}/{device}/last-device-recovery/key/reset: requests a delayed recovery key reset (docs/recovery-key-reset.md).

Link copied to clipboard

GET /v1/devices/{user}/{device}/last-device-recovery/key/reset: the user's pending recovery key reset.

Link copied to clipboard

PUT /v1/devices/{user}/{device}/last-device-recovery/key/reset/completion: completes the pending reset.

Link copied to clipboard

PUT /v1/devices/{user}/{device}/last-device-recovery/key/reset/cancellation: cancels the pending reset.

Link copied to clipboard

POST /v1/messages: submits an envelope whose sender is the authenticated device (S1, docs/server-authentication.md). Not device-scoped in its path: the signed path is exactly ServerApiPaths.SUBMIT_MESSAGE, the device comes from the signed request's address.

Properties

Link copied to clipboard
Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun path(address: DeviceAddress): String

The canonical path a request of address for this endpoint signs.

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.