Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Unified instance and user Secret lifecycle, revision values and OAuth integration management.
vault.get()vault.create()vault.update()vault.delete()vault.rotate()vault.listRevisions()vault.getAccessToken()vault.getIntegrationMetadata()vault.discoverIntegration()vault.connectIntegration()vault.disconnectIntegration()vault.get()static get(name: string, options?: SecretGetOptions): Promise<SecretWithValue>;
const secret = await vault.get('TOKEN', { scope: 'user' });
const token = secret.revision.value.toString('utf8');
vault.create()static create(name: string, data: SecretCreateInput, options?: SecretScopeOptions): Promise<Secret | null>;
const secret = await vault.create('TOKEN', { value: input.token }, { scope: 'user' });
vault.update()static update(name: string, data: SecretUpdateInput, options?: SecretScopeOptions): Promise<Secret | null>;
const current = await vault.get('TOKEN');
await vault.update('TOKEN', { version: current.version, description: 'CRM credential' });
vault.delete()static delete(name: string, options?: SecretDeleteOptions): Promise<void | null>;
await vault.delete('TOKEN', { scope: 'user', validFrom: input.version });
vault.rotate()static rotate(name: string, data: SecretRotateInput, options?: SecretRotateOptions): Promise<SecretWithRevision | null>;
const rotated = await vault.rotate('TOKEN', { value: input.token }, { scope: 'user', validFrom: null });
vault.listRevisions()static listRevisions(name: string, options?: SecretRevisionListOptions): Promise<SecretRevisionPage>;
vault.getAccessToken()static getAccessToken(name: string, options?: SecretScopeOptions): Promise<VaultAccessToken>;
const token = await vault.getAccessToken('CRM', { scope: 'user' });
await api.httpCall({ url: input.url, headers: { Authorization: `Bearer ${token.accessToken}` } });
vault.getIntegrationMetadata()static getIntegrationMetadata(name: string, options?: SecretScopeOptions): Promise<VaultIntegrationMetadata>;
vault.discoverIntegration()static discoverIntegration(name: string, data: VaultIntegrationConfig, options?: SecretScopeOptions): Promise<VaultIntegrationDiscovery>;
vault.connectIntegration()static connectIntegration(name: string, data: VaultConnectIntegrationInput, options?: SecretScopeOptions): Promise<VaultIntegrationConnectResult | null>;
const pending = await vault.connectIntegration('CRM', {
resourceUrl: input.resourceUrl, scopes: ['read'], expectedRevision: null,
}, { scope: 'user' });
vault.disconnectIntegration()static disconnectIntegration(name: string, options?: SecretScopeOptions): Promise<{ name: string; disabled: boolean } | null>;