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>]
| Option | Description |
|---|
--email, -e | Filter users by email (case-insensitive substring match) |
--status, -s | Filter by status: active or invited. Can be specified multiple times. |
--limit, -l | Maximum number of results to return (1-100, default: 50) |
--cursor, -c | Pagination 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.
Example:
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]
| Option | Description |
|---|
--full-name, -n | Full name for the user (1-255 characters) |
--email, -e | Email address (used as the idempotency key) |
--role, -r | Account-level predefined role: admin, member, or annotator |
--invite-mode | Invite mode: none, email_link, or temporary_password |
--is-not-developer | Disable 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]
| Option | Description |
|---|
--full-name, -n | New full name for the user |
--is-developer / --is-not-developer | Update 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]
| Option | Description |
|---|
--force, -f | Skip 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