Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Class UsersResource

    Users are people who belong to your organization. Access this resource through AdminClient.users; do not construct it directly. Use AdminClient.invites to invite new members.

    import { AdminClient } from '@pinecone-database/pinecone';

    const admin = new AdminClient();
    const result = await admin.users.list();
    Index
    constructor
    delete describe list

    • Removes a user from the organization.

      Parameters

      • userId: string

        The ID of the user to remove.

      Returns Promise<void>

      Resolves when the deletion request succeeds.

      Errors.PineconeArgumentError when userId is empty.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      await admin.users.delete('bf77a06e-cd10-41c8-af91-a7fa389dce2c');

    • Retrieves a user by ID.

      Parameters

      Returns Promise<User>

      The user details.

      Errors.PineconeArgumentError when userId is empty.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      const result = await admin.users.describe('bf77a06e-cd10-41c8-af91-a7fa389dce2c');
      console.log(result);

    • Lists one page of users, optionally filtered by email.

      Parameters

      • options: ListUsersOptions = {}

        Filters and pagination settings. Omit to fetch the first page without filters.

      Returns Promise<UserList>

      Results in data; pass pagination.next as paginationToken to fetch the next page.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      const result = await admin.users.list({ limit: 10 });
      console.log(result.data);

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods