neosourceDocs
Search docs

Create a personal access token

POST/api/user/tokens

createPersonalAccessToken

Creates a PAT for the authenticated user. The raw token value is only returned once in this response. **Requires sudo-mode** (plans/auth-flows.md slice #5) — *unless* the account holds no step-up credential yet (a freshly OAuth-claimed / passwordless account with no password, TOTP, or passkey, which has no way to acquire sudo and would otherwise be permanently locked out of PAT creation). Once any step-up credential exists this is sudo-gated again. Returns `403 { error: "sudo_required", challenge: "password"|"totp" }` if the sudo window has elapsed. The bearer-token security entry is intentionally dropped here — a PAT can't sudo, and creating a new PAT from a CLI session is a future concern.

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

curl

curl -X POST 'https://neosource.dev/api/user/tokens' \
  -b 'ns_session=$NEOSOURCE_SESSION' \
  -H 'Content-Type: application/json' \
  -d '{"label":"ci"}'

fetch

fetch("https://neosource.dev/api/user/tokens", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({"label":"ci"}),
});

neo

neo token create LABEL

Request bodyrequired

application/json

CreateTokenRequest

object

expires_in_days

integer | nullint32

Lifetime in days. Defaults to 90, capped at 400 — a token can never be immortal (ADR 0069).

example90

labelrequired

string

example"ci"

repo_ids

array | null

Optional repo resource-lock (repo UUIDs). When set the token may only act on these repos.

items

string

scopes

array

Scope grant (ADR 0069). Deliberately an open `Vec<String>` over the hierarchical permission vocabulary (validated server-side against the grantable catalog) — not an enum. Empty ⇒ full authority (`["*"]`).

items

string

workspace_ids

array | null

Optional workspace resource-lock (workspace UUIDs).

items

string

additional propertiesnot allowed

Responses

201Token created

application/json

CreateTokenResponse

object

created_atrequired

integerint64

expires_at

integer | nullint64

labelrequired

string

raw_tokenrequired

string

token_idrequired

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
  • 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