ClientKeysManager

Client Keys management client

Provides methods for managing client keys for service-to-service authentication. Client keys allow external services to authenticate without user credentials.

Example

const client = createClient({ url: 'http://localhost:8080' })
await client.auth.login({ email: 'user@example.com', password: 'password' })

// Create a client key
const { client_key, key } = await client.management.clientKeys.create({
  name: 'Production Service',
  scopes: ['read:users', 'write:users'],
  rate_limit_per_minute: 100
})

// List client keys
const { client_keys } = await client.management.clientKeys.list()

Constructors

new ClientKeysManager()

new ClientKeysManager(fetch): ClientKeysManager

Parameters

Parameter	Type
fetch	FluxbaseFetch

Returns

ClientKeysManager

Methods

create()

create(request): Promise<CreateClientKeyResponse>

Create a new client key

Parameters

Parameter	Type	Description
request	CreateClientKeyRequest	Client key configuration

Returns

Promise<CreateClientKeyResponse>

Created client key with the full key value (only shown once)

Example

const { client_key, key } = await client.management.clientKeys.create({
  name: 'Production Service',
  description: 'Client key for production service',
  scopes: ['read:users', 'write:users'],
  rate_limit_per_minute: 100,
  expires_at: '2025-12-31T23:59:59Z'
})

// Store the key securely - it won't be shown again
console.log('Client Key:', key)

---

delete()

delete(keyId): Promise<DeleteClientKeyResponse>

Delete a client key

Permanently removes the client key from the system.

Parameters

Parameter	Type	Description
keyId	string	Client key ID

Returns

Promise<DeleteClientKeyResponse>

Deletion confirmation

Example

await client.management.clientKeys.delete('key-uuid')
console.log('Client key deleted')

---

get()

get(keyId): Promise<ClientKey>

Get a specific client key by ID

Parameters

Parameter	Type	Description
keyId	string	Client key ID

Returns

Promise<ClientKey>

Client key details

Example

const clientKey = await client.management.clientKeys.get('key-uuid')
console.log('Last used:', clientKey.last_used_at)

---

list()

list(): Promise<ListClientKeysResponse>

List all client keys for the authenticated user

Returns

Promise<ListClientKeysResponse>

List of client keys (without full key values)

Example

const { client_keys, total } = await client.management.clientKeys.list()

client_keys.forEach(key => {
  console.log(`${key.name}: ${key.key_prefix}... (expires: ${key.expires_at})`)
})

---

revoke()

revoke(keyId): Promise<RevokeClientKeyResponse>

Revoke a client key

Revoked keys can no longer be used but remain in the system for audit purposes.

Parameters

Parameter	Type	Description
keyId	string	Client key ID

Returns

Promise<RevokeClientKeyResponse>

Revocation confirmation

Example

await client.management.clientKeys.revoke('key-uuid')
console.log('Client key revoked')

---

update()

update(keyId, updates): Promise<ClientKey>

Update a client key

Parameters

Parameter	Type	Description
keyId	string	Client key ID
updates	UpdateClientKeyRequest	Fields to update

Returns

Promise<ClientKey>

Updated client key

Example

const updated = await client.management.clientKeys.update('key-uuid', {
  name: 'Updated Name',
  rate_limit_per_minute: 200
})