api.md: update device authorized API docs to allow for deauth (#8162)

The authorize device API (/api/v2/device/{deviceID}/authorized)
will soon allow device deauthorisation.

Fixes corp#10160.

Signed-off-by: salman <salman@tailscale.com>
pull/8187/head
salman aljammaz 2 years ago committed by GitHub
parent a4fd4fd845
commit 745ee97973
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -503,7 +503,8 @@ Returns the enabled and advertised subnet routes for a device.
POST /api/v2/device/{deviceID}/authorized POST /api/v2/device/{deviceID}/authorized
``` ```
Authorize a device. This call marks a device as authorized for tailnets where device authorization is required. Authorize a device.
This call marks a device as authorized or revokes its authorization for tailnets where device authorization is required, according to the `authorized` field in the payload.
This returns a successful 2xx response with an empty JSON object in the response body. This returns a successful 2xx response with an empty JSON object in the response body.
@ -515,7 +516,7 @@ The ID of the device.
#### `authorized` (required in `POST` body) #### `authorized` (required in `POST` body)
Specify whether the device is authorized. Only 'true' is currently supported. Specify whether the device is authorized.
``` jsonc ``` jsonc
{ {

Loading…
Cancel
Save