neosourceDocs
Search docs

Rotate a workspace access token's secret

POST/api/orgs/{org}/tokens/{token_id}/rotate

rotateOrgToken

Session-authenticated caller only. Admin/Owner + sudo, with the zero-step-up-credential carve-out used by personal PAT management when no password, enabled TOTP, or passkey exists. Keeps the token id and grant; the old secret dies immediately. New raw value returned once.

Requires authentication using a session cookie — see tokens and scopes.

curl

curl -X POST 'https://neosource.dev/api/orgs/ORG/tokens/TOKEN_ID/rotate' \
  -b 'ns_session=$NEOSOURCE_SESSION'

fetch

fetch("https://neosource.dev/api/orgs/ORG/tokens/TOKEN_ID/rotate", {
  method: "POST",
  credentials: "include",
});

Path parameters

orgrequired

string

token_idrequired

string

Responses

200Rotated

application/json

RotateOrgTokenResponse

object

expires_at

integer | nullint64

raw_tokenrequired

string

403Forbidden — one of: forbidden, sudo_required

application/json

one of
  • ErrorForbidden

  • SudoRequiredError

    object

    Wire shape of the 403 a sudo-gated endpoint returns when sudo is missing or expired. `challenge` tells the SPA which sudo-prove endpoint to call.

    challengerequired

    string

    Which sudo-prove endpoint the account should use: `"passkey"` (`/api/auth/sudo/passkey/{start,finish}`), `"password"` (`/api/auth/sudo/password`), or `"totp"` (`/api/auth/sudo/totp`), chosen from the account's registered credentials — passkey first when present, since it is both the strongest credential and the least friction. A hint for which prompt to show first, not an authorization decision: each sudo route verifies its own credential regardless of what was advertised here, so a client may use a different one.

    errorrequired

    string

    Always `sudo_required` — this body exists to carry the extra fields that kind needs.

    "sudo_required"

    messagerequired

    string

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 401Authentication required
  • 404Not Found — one of: not_found
  • 409Conflict — one of: already_exists, conflict
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget