User Management (RBAC)

When the service runs with CYBORGDB_SERVICE_ROOT_KEY set, the JS/TS SDK exposes per-index user provisioning on EncryptedIndex. These calls require the client to be using the root API key.

See Multi-Tenancy & RBAC for the operator-side playbook (modes, key kinds, KMS-backed constraint).

createUser

Mint a per-user API key scoped to this index.

async createUser({
    permissions: string[]
}): Promise<{ userId: string; apiKey: string }>

Parameters

Parameter	Type	Description
`permissions`	`string[]`	Non-empty subset of `["read", "write"]`. Enforced cryptographically by the service.

Returns

Promise<{ userId, apiKey }>:

Field	Type	Description
`userId`	`string`	Hex-encoded identifier for the new user.
`apiKey`	`string`	The user’s API key (`cdbk_…`). Returned exactly once and never stored — capture it now.

The apiKey is shown only in this response and is never persisted by the service. Hand it to the user securely. If lost, revoke and re-mint.

Example

import { Client } from 'cyborgdb';

const admin = new Client({ baseUrl: 'http://localhost:8000', apiKey: ROOT_KEY });
const index = await admin.loadIndex({ indexName: 'documents' });  // KMS-backed: no indexKey

const { userId, apiKey } = await index.createUser({ permissions: ['read', 'write'] });
// capture apiKey once — never recoverable

KMS-backed vs SDK-supplied indexes. createUser needs to unwrap the index’s root DEK so it can re-wrap it under a fresh user key.

KMS-backed (kmsName set): the service unwraps the DEK server-side; the client just calls createUser on the loaded index — no indexKey is sent or required.
SDK-supplied (indexKey set at loadIndex): the SDK transparently forwards the index key to the server so it can perform the unwrap. The root client must have loaded the index with the correct indexKey, otherwise the call fails.

The same asymmetry applies to listUsers and deleteUser.

Errors

Throws if permissions is empty/invalid, the client is not using the root key, or RBAC is not enabled.

listUsers

List the users provisioned for this index.

async listUsers(): Promise<{ userId: string; permissions: string[] }[]>

Returns

Array of { userId, permissions }. Permissions are derived from which wrapped DEKs exist for the user.

Example

const users = await index.listUsers();
for (const u of users) {
    console.log(u.userId, u.permissions);
}

Errors

Throws if the client is not using the root key, or RBAC is not enabled.

deleteUser

Revoke a user. Erases their wrapped DEK(s) for this index — even a captured cdbk_… token becomes useless on the next request. No propagation lag.

async deleteUser({ userId }: { userId: string }): Promise<void>

Parameters

Parameter	Type	Description
`userId`	`string`	Hex `userId` from `createUser` (or `listUsers`).

Example

await index.deleteUser({ userId: 'a1b2c3d4e5f6' });

Errors

Throws if userId is invalid, the client is not using the root key, or RBAC is not enabled.

Introduction

Client

Encrypted Index

Types & Helpers

createUser

Parameters

Returns

Example

Errors

listUsers

Returns

Example

Errors

deleteUser

Parameters

Example

Errors

​createUser

​Parameters

​Returns

​Example

​Errors

​listUsers

​Returns

​Example

​Errors

​deleteUser

​Parameters

​Example

​Errors

createUser

Parameters

Returns

Example

Errors

listUsers

Returns

Example

Errors

deleteUser

Parameters

Example

Errors