Docsbook
Overview

Update access

POST/api/v1/update_access

Make a workspace private and configure its unlock method (password and/or bring-your-own SSO/OIDC identity provider — Google Workspace, Entra ID, Okta). Available on every plan. Anonymous readers of a private workspace must unlock it with the password or sign in via SSO before seeing any content; the owner always has access. This is the call for internal documentation — a team wiki, specs, decision records — that must not be readable by strangers. Pair it with the page lifecycle (set_doc_status, get_doc_outline) when the corpus is engineering documentation agents build from.

Price — $0.00001 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.

Also reachable by name at POST /api/v1/tools/update_access.

Authorization
Authorizationstringrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Body
visibilitystring

Whether the workspace requires unlocking to read One of: public, private.

passwordstring

Shared unlock password (min 8 chars), or null to remove password unlock

ssostring

Bring-your-own OIDC identity provider config, or null to remove SSO unlock

Request
curl -X POST 'https://docsbook.io/api/v1/update_access' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"visibility":"public"}'

Responses#

Status Meaning
200 The tool ran. Read ok to see whether it succeeded.
401 Missing or invalid API key.

Updated

Was this page helpful?