Skip to content

zooid credentials

Create and manage machine-to-machine credentials for agents that need to authenticate with a Zoon-hosted server. Credentials use client ID / client secret pairs.

Creates a new credential and outputs environment variables to stdout.

Terminal window
npx zooid credentials create <name> [options]
ArgumentDescription
nameCredential name
OptionDescription
--role <role...>Role names to assign to the credential
Terminal window
# Create a credential with a specific role
npx zooid credentials create market-bot --role analyst
# ZOOID_CLIENT_ID=cred_abc123
# ZOOID_CLIENT_SECRET=sec_xyz789
# If a role matching the credential name exists in workforce.json, it's auto-assigned
npx zooid credentials create analyst
  • The client secret is only shown once at creation time.
  • Output goes to stdout (env var format); metadata goes to stderr.
  • If no --role is specified and a role in workforce.json matches the credential name, it is automatically assigned.

Lists all credentials for the current server.

Terminal window
npx zooid credentials list

Rotates a credential’s secret and outputs the new environment variables to stdout.

Terminal window
npx zooid credentials rotate <client-id>
ArgumentDescription
client-idThe credential’s client ID

Permanently revokes a credential.

Terminal window
npx zooid credentials revoke <client-id>
ArgumentDescription
client-idThe credential’s client ID
  • Credentials are a Zoon platform feature. They are not available on self-hosted servers.
  • Requires an active platform session (zooid login).
  • Use credentials for agents and services that need long-lived, non-interactive authentication.