Arize Phoenix TS
    Preparing search index...

    Function getCurrentUser

    • Get the currently authenticated user.

      When authentication is disabled, Phoenix returns an anonymous user with auth_method: "ANONYMOUS".

      Parameters

      • params: ClientFn = {}

        The parameters for fetching the current user.

        • Optionalclient?: {
              config: PhoenixClientOptions;
              DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
              GET: ClientMethod<paths, "get", `${string}/${string}`>;
              getServerVersion: () => Promise<SemanticVersion>;
              HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
              OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
              PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
              POST: ClientMethod<paths, "post", `${string}/${string}`>;
              PUT: ClientMethod<paths, "put", `${string}/${string}`>;
              request: ClientRequestMethod<paths, `${string}/${string}`>;
              TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
              eject(...middleware: Middleware[]): void;
              use(...middleware: Middleware[]): void;
          }

          An instance of the Phoenix client. If not provided, the client will be created using the default configuration.

          • config: PhoenixClientOptions
          • DELETE: ClientMethod<paths, "delete", `${string}/${string}`>

            Call a DELETE endpoint

          • GET: ClientMethod<paths, "get", `${string}/${string}`>

            Call a GET endpoint

          • getServerVersion: () => Promise<SemanticVersion>

            Get the Phoenix server version, returning a cached value if available.

            The version is first populated from the x-phoenix-server-version response header on any API call. If no version has been seen yet, this method fetches GET /arize_phoenix_version to populate the cache.

            If the server version cannot be determined (e.g. the server is unreachable or returned an unparseable version string).

          • HEAD: ClientMethod<paths, "head", `${string}/${string}`>

            Call a HEAD endpoint

          • OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>

            Call a OPTIONS endpoint

          • PATCH: ClientMethod<paths, "patch", `${string}/${string}`>

            Call a PATCH endpoint

          • POST: ClientMethod<paths, "post", `${string}/${string}`>

            Call a POST endpoint

          • PUT: ClientMethod<paths, "put", `${string}/${string}`>

            Call a PUT endpoint

          • request: ClientRequestMethod<paths, `${string}/${string}`>
          • TRACE: ClientMethod<paths, "trace", `${string}/${string}`>

            Call a TRACE endpoint

          • eject: function
            • eject(...middleware: Middleware[]): void

              Unregister middleware

              Parameters

              • ...middleware: Middleware[]

              Returns void

          • use: function
            • use(...middleware: Middleware[]): void

              Register middleware

              Parameters

              • ...middleware: Middleware[]

              Returns void

      Returns Promise<
          | { auth_method: "ANONYMOUS" }
          | {
              auth_method: "LOCAL";
              created_at: string;
              email: string;
              id: string;
              password?: string;
              password_needs_reset: boolean;
              role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
              updated_at: string;
              username: string;
          }
          | {
              auth_method: "OAUTH2";
              created_at: string;
              email: string;
              id: string;
              oauth2_client_id?: string;
              oauth2_user_id?: string;
              profile_picture_url?: string;
              role: "SYSTEM"
              | "ADMIN"
              | "MEMBER"
              | "VIEWER";
              updated_at: string;
              username: string;
          }
          | {
              auth_method: "LDAP";
              created_at: string;
              email: string;
              id: string;
              role: "SYSTEM"
              | "ADMIN"
              | "MEMBER"
              | "VIEWER";
              updated_at: string;
              username: string;
          },
      >

      The current user's generated API profile shape.

      If the request is not authenticated or is forbidden.

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

      const user = await getCurrentUser();
      console.log(user.auth_method);

    Settings
    Member Visibility