enumeray auth

Configure service profiles, authenticate and manage delegated API tokens.

Use when: You are connecting a person or automation identity to an API, switching services or renewing/revoking access.

Role and prerequisites: Any account or automation identity. Install enumeray, configure the API and log in. Use an account or delegated token with the required permissions. Example IDs must be replaced with IDs from your service.

Example

enumeray --profile research auth configure https://enumeray.example.org
enumeray --profile research auth login
enumeray --profile research auth whoami

Every command also accepts the profile, API, JSON and timeout options.

Choose a subcommand

Command	Purpose
login	Log in through a browser with PKCE, or save an existing API token from stdin.
refresh	Renew the selected profile’s browser login with its saved refresh token.
logout	Remove locally saved credentials for the selected profile.
whoami	Inspect the authenticated account and its authority.
profiles	List configured API profiles without credential secrets.
configure	Save an API origin in the selected local profile.
token-create	Create a scoped expiring API token and save its secret privately.
token-list	List metadata for your delegated API tokens.
token-revoke	Permanently revoke one of your delegated API tokens.

Result and next step

Choose a subcommand below. The group itself performs no operation.

Follow login and profiles before running authenticated commands.

Exact syntax, defaults and accepted values

Configure API profiles, sign in and manage delegated tokens

Usage: enumeray auth [OPTIONS] <COMMAND>

Commands:
  login         Browser-assisted authorization code login with PKCE; API must expose auth/config
  refresh       Renew the selected browser login using its saved refresh token
  logout        Clear this profile's local credentials without revoking server tokens
  whoami        Inspect the authenticated account, stable user ID and authority
  profiles      List configured profiles without credentials
  configure     Create/select this profile's API origin; changing origin clears old credentials
  token-create  Create a scoped, expiring token and save the secret to a private file
  token-list    List your delegated-token metadata without revealing secrets
  token-revoke  Permanently revoke one of your delegated tokens by ID
  help          Print this message or the help of the given subcommand(s)

Options:
      --api <API>          User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
      --profile <PROFILE>  Named local user API/login profile; host/runner commands use explicit configuration [default: default]
      --config <CONFIG>    Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
      --json               Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol
      --timeout <TIMEOUT>  User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60]
  -h, --help               Print help