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

    Class RoleBindingsResource

    Role bindings grant a user, service account, API key, or invite a role on an organization or project. Access this resource through AdminClient.roleBindings; do not construct it directly. Use AdminClient.invites to invite someone who is not yet a member.

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

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

    • Grants a role to a user, service account, API key, or invite.

      Parameters

      • options: CreateRoleBindingRequest

        The principal, role, and resource scope. Supply resourceId for a project-scoped role.

      Returns Promise<RoleBinding>

      The new role binding, including its id.

      Errors.PineconeArgumentError when the principal ID, principal type, resource type, or role is empty.

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

      const admin = new AdminClient();
      const binding = await admin.roleBindings.create({
        principalType: 'service_account',
        principalId: '7e730a1d-8c0f-48f1-a9a3-1ac66fdd2ef4',
        resourceType: 'project',
        resourceId: '8a3e2d1c-0b9f-4e6d-8c7b-5a4f3e2d1c0b',
        role: 'ProjectViewer',
      });
      console.log(binding.id);

    • Deletes a role binding, removing the role it grants.

      Parameters

      • roleBindingId: string

        The ID of the role binding to delete.

      Returns Promise<void>

      Resolves when the deletion request succeeds.

      Errors.PineconeArgumentError when roleBindingId is empty.

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

      const admin = new AdminClient();
      await admin.roleBindings.delete('17470909-6cb1-4db1-93ef-20ab82595683');

    • Retrieves a role binding by ID.

      Parameters

      • roleBindingId: string

        The role binding ID returned when it was created or listed.

      Returns Promise<RoleBinding>

      The role binding details.

      Errors.PineconeArgumentError when roleBindingId is empty.

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

      const admin = new AdminClient();
      const result = await admin.roleBindings.describe('17470909-6cb1-4db1-93ef-20ab82595683');
      console.log(result);

    • Lists one page of role bindings, optionally filtered by principal, resource, or role.

      Parameters

      • options: ListRoleBindingsOptions = {}

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

      Returns Promise<RoleBindingList>

      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.roleBindings.list({ limit: 10 });
      console.log(result.data);

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods