Skip to main content

Documentation Index

Fetch the complete documentation index at: https://arize-ax.mintlify.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

The ax users commands are currently in ALPHA. The API may change without notice. A one-time warning is emitted on first use.
The ax users commands let you create, retrieve, update, and delete users on the Arize platform.

ax users list

List users in the account, optionally filtered by email or status.
ax users list [--email <filter>] [--status <status>] [--limit <n>] [--cursor <cursor>]
OptionDescription
--email, -eFilter users by email (case-insensitive substring match)
--status, -sFilter by status: active or invited. Can be specified multiple times.
--limit, -lMaximum number of results to return (1-100, default: 50)
--cursor, -cPagination cursor for the next page
Examples:
ax users list
ax users list --email "@example.com" --status active
ax users list --output users.json

ax users get

Get a user by ID.
ax users get <user-id>
Example:
ax users get usr_abc123

ax users create

Create a new user with a builtin account-level role. The --role flag accepts predefined role names: admin, member, or annotator.
ax users create --full-name <name> --email <email> --role <role> --invite-mode <mode> [--is-not-developer]
OptionDescription
--full-name, -nFull name for the user (1-255 characters)
--email, -eEmail address (used as the idempotency key)
--role, -rAccount-level predefined role: admin, member, or annotator
--invite-modeInvite mode: none, email_link, or temporary_password
--is-not-developerDisable developer permissions. By default, new users are granted developer permissions to use the Arize API.
Example:
ax users create \
  --full-name "Jane Doe" \
  --email jane@example.com \
  --role member \
  --invite-mode email_link

ax users update

Update a user’s full name or developer permission flag. At least one of --full-name or --is-developer/--is-not-developer must be provided.
ax users update <user-id> [--full-name <name>] [--is-developer | --is-not-developer]
OptionDescription
--full-name, -nNew full name for the user
--is-developer / --is-not-developerUpdate developer permission flag
Examples:
ax users update usr_abc123 --full-name "Jane Smith"
ax users update usr_abc123 --is-not-developer

ax users delete

Delete a user by ID. This deletes the user and cascades to organization memberships, space memberships, API keys, and role bindings.
ax users delete <user-id> [--force]
OptionDescription
--force, -fSkip the confirmation prompt
Examples:
ax users delete usr_abc123
ax users delete usr_abc123 --force

ax users resend-invitation

Resend an invitation email for a pending (invited) user.
ax users resend-invitation <user-id>
Example:
ax users resend-invitation usr_abc123

ax users reset-password

Send a password-reset email to a user. The user must authenticate via password (not SSO/SAML) and must have already verified their account.
ax users reset-password <user-id>
Example:
ax users reset-password usr_abc123