Skip to content
Build with Mammoth › CLI reference: open the docs menu

mammoth token

Generated from mammoth-cli 2.4.2, released 2026-11-02: mammoth schema list, mammoth capability list and the CLI's own --help. Do not edit by hand; run npm run docs:capabilities.

Create, list, and revoke long-lived API keys (aliases of client-app). 3 commands.

Every command also takes the global flags (--output, --yes, --confirm, --dry-run, --input, --profile, ...), which are not repeated below. --input takes a JSON or YAML document of the input fields; mammoth schema get COMMAND_ID prints a command's full input schema.

Confirmation. Commands marked --yes --confirm TARGET or --yes always need those flags, even at a terminal: they never prompt. Commands marked "--yes or prompt" ask at an interactive terminal (table output, no --no-input) and otherwise need --yes. --dry-run skips confirmation and sends nothing.

Summary

CommandWhat it doesEffectConfirmation
token createCreate a client app. Name comes from a positional or the 'app_name' field.High impact--yes --confirm TARGET
token listList the workspace's API keys (client apps). Requires an admin role.Read—
token revokePermanently delete one client app by its client key. Prompt or '--yes' required.Destructive--yes or prompt

token commands

mammoth token create

Create a client app. Name comes from a positional or the 'app_name' field.

mammoth token create 'Revenue report' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
APP_NAMEpositionalno—strName of the new API key; or pass it via the 'app_name' input field. Or the app_name input field.
app_name--input fieldno—str
description--input fieldno—str
  • Effect: High impact, scope profile · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: The token is shown once, in this response only; store it at once. It is redacted from logs and diagnostics. Needs --yes.
  • Id: token.create · Result: ClientAppCreateResult

mammoth token list

List the workspace's API keys (client apps). Requires an admin role.

mammoth token list
NamePassed asRequiredDefaultTypeNotes
limit--input fieldno10int
offset--input fieldno0int
fields--input fieldno—str
sort--input fieldno—str
  • Effect: Read, scope profile · Confirmation: none · Pages: offset
  • Preconditions: Lists the workspace's API tokens.
  • Id: token.list · Result: ClientAppListResult

mammoth token revoke

Permanently delete one client app by its client key. Prompt or '--yes' required.

mammoth token revoke web-client --yes
NamePassed asRequiredDefaultTypeNotes
CLIENT_KEYpositionalyes—strKey identifying the client.
  • Effect: Destructive, scope profile · Confirmation: --yes, or answer the prompt at an interactive terminal
  • Preconditions: Revokes the token for good; anything using it stops working. Needs --yes and --confirm with the exact token key.
  • Id: token.revoke · Result: ClientAppDeleteResult

Report an issue · support@mammoth.io