Faurya CLI

Authentication

Log in to the Faurya CLI, confirm account identity, understand site-scoped access, and handle denied access.

Authentication

The CLI supports normal user login for account and multi-website workflows. Some site-scoped commands can also be used with a site API key when the key is valid for that website and has the required access.

Log in

faurya login

Use an interactive terminal. After login, the CLI stores a local credential for future commands.

Confirm the active account

faurya whoami
faurya account get

Both commands require normal CLI user access. A site API key is site-scoped and is not a replacement for account identity commands.

List sites available to the account

faurya website list

Use this command to find the <websiteId> values you can use with site-scoped commands.

Log out

faurya logout

Logout removes the stored local login credential. It does not revoke credentials in your Faurya account; revoke or rotate credentials from the appropriate Faurya settings workflow when needed.

Authentication expiration and revoked access

A command can fail if your stored credential expires, is revoked, belongs to a user without product access, or no longer has access to the requested website. Log in again, then retry a read-only command first.

faurya login
faurya whoami
faurya website list

User access and site API keys

Normal CLI user access is intended for account-level workflows, listing websites, managing teams, managing alerts, changing website settings, and managing site API keys when your role allows it.

A site API key is scoped to one website. It is useful for automation against that website, but it cannot manage other site API keys. Site API-key access is limited by the website and permissions associated with the key.

Site-scoped access

Most commands require <websiteId>. The CLI verifies that the active credential can access that website. If you belong to multiple websites, always copy the website ID from website list before running write or destructive commands.

Role and permission limits

Access depends on your Faurya role, the website, and the feature area. For example:

AreaTypical requirement
Analytics readsAnalytics access for the website.
Funnel writesFunnel write access for the website.
Website settings writesSettings write access for the website.
Team changesTeam write access and a role allowed to manage members.
Alert changesAlert write access for the website.
Site API-key managementSite API-key access and a role allowed to manage keys.

If access is denied, verify that you are using the correct website, then ask a website owner or admin to adjust your role or permissions.

Credential safety

  • Do not paste credentials into tickets, chat messages, documentation, or source code.
  • Prefer interactive login for local work.
  • Store site API keys only in your secret manager or deployment platform.
  • Rotate a site API key if it may have been exposed.
  • Revoke credentials that are no longer needed.