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 users functions are currently in ALPHA. The API may change without notice. A one-time warning is emitted on first use.

​
List Users

Results are sorted by creation date ascending (oldest first). Requires account admin role, member role, or USER_READ permission. 
import { listUsers } from "@arizeai/ax-client";

const { data: users, pagination } = await listUsers({
  email: "example.com",         // optional case-insensitive partial match
  status: ["active", "invited"], // optional array of user statuses
  limit: 50,
});

​
Create a User

Create a new account user with explicit invite control. Idempotent on email when inviteMode !== "none". Requires account admin role or USER_CREATE permission. 
import { createUser } from "@arizeai/ax-client";

const user = await createUser({
  name: "Jane Smith",
  email: "jane.smith@example.com",
  role: { type: "predefined", name: "member" },
  inviteMode: "email_link",  // "none" | "email_link" | "temporary_password"
});

​
Invite Modes

ModeBehavior
nonePre-provision the user directly (no invitation email). For SSO-only accounts.
email_linkSend a verification link via email.
temporary_passwordIssue a one-time password returned in the response. User must reset it on first login.

​
Get a User

Requires account admin role, member role, or USER_READ permission. 
import { getUser } from "@arizeai/ax-client";

const user = await getUser({ userId: "your_user_id" });

​
Update a User

Update the display name and/or developer permission. At least one of name or isDeveloper must be provided. Requires account admin role or USER_UPDATE permission. 
import { updateUser } from "@arizeai/ax-client";

const user = await updateUser({
  userId: "your_user_id",
  name: "Jane Smith Updated",
  isDeveloper: true,
});

​
Delete a User

Permanently blocks the user from the account (sets status to inactive, a terminal state). Cascades to organization memberships, space memberships, API keys, and role bindings. Blocked users cannot be re-invited. Callers cannot delete themselves. Requires account admin role or USER_DELETE permission. 
import { deleteUser } from "@arizeai/ax-client";

await deleteUser({ userId: "your_user_id" });

​
Resend Invitation

Regenerate the verification token and resend the invitation email. The target user must be in the invited state. Returns 400 if the user has already verified their account or if SAML/IdP login is enforced. Requires account admin role or USER_CREATE permission. 
import { resendInvitation } from "@arizeai/ax-client";

await resendInvitation({ userId: "your_user_id" });

​
Reset Password

Trigger a password-reset email for a user. Generates a reset token and sends an email with a 30-minute link. Returns 400 if the user authenticates via SSO/SAML or has not yet verified their account. Requires account admin role or USER_UPDATE permission. 
import { resetPassword } from "@arizeai/ax-client";

await resetPassword({ userId: "your_user_id" });