Users

The users module identifies the user associated with the client’s current credentials.

Get The Current User

import { getCurrentUser } from "@arizeai/phoenix-client/users";

const user = await getCurrentUser();

if (user.auth_method === "ANONYMOUS") {
  console.log("Authentication is disabled");
} else {
  console.log(`${user.username} has the ${user.role} role`);
}

getCurrentUser() returns the generated Phoenix API user union. Authenticated deployments return a local, OAuth 2, or LDAP user profile. When authentication is disabled, it returns { auth_method: "ANONYMOUS" }. Invalid credentials reject with an HttpError whose status is 401; other authorization failures retain their HTTP status as well. Pass a client explicitly when you need custom configuration:

import { createClient } from "@arizeai/phoenix-client";
import { getCurrentUser } from "@arizeai/phoenix-client/users";

const client = createClient({
  options: { baseUrl: "https://phoenix.example.com" },
});

const user = await getCurrentUser({ client });

Source Map

src/users/getCurrentUser.ts
src/users/index.ts
src/generated/api/v1.ts

Python

TypeScript

Rest API

OpenInference SDK

Get The Current User

Source Map

​Get The Current User

​Source Map

Get The Current User

Source Map