Skip to main content

OpenBaoSecretsService

Workspace API

Workspace API / services/mcp/OpenBaoSecretsService

services/mcp/OpenBaoSecretsService

Classes​

OpenBaoSecretsService​

Defined in: services/mcp/OpenBaoSecretsService.ts:43

OpenBao Secrets Service

Provides secure secret management for MCP integrations.

Constructors​

Constructor​

new OpenBaoSecretsService(): OpenBaoSecretsService

Defined in: services/mcp/OpenBaoSecretsService.ts:49

Returns​

OpenBaoSecretsService

Methods​

getSecret()​

getSecret(path): Promise<Secret | null>

Defined in: services/mcp/OpenBaoSecretsService.ts:61

Get a secret from OpenBao

Parameters​
path​

string

Returns​

Promise<Secret | null>

getApiKey()​

getApiKey(secretPath): Promise<string | null>

Defined in: services/mcp/OpenBaoSecretsService.ts:140

Get API key for an MCP server

Parameters​
secretPath​

string

Returns​

Promise<string | null>

getOAuth2Token()​

getOAuth2Token(secretPath): Promise<OAuth2Token | null>

Defined in: services/mcp/OpenBaoSecretsService.ts:151

Get OAuth2 token for an MCP server

Parameters​
secretPath​

string

Returns​

Promise<OAuth2Token | null>

getMTLSCert()​

getMTLSCert(secretPath): Promise<{ cert: string; key: string; } | null>

Defined in: services/mcp/OpenBaoSecretsService.ts:171

Get mTLS certificate for an MCP server

Parameters​
secretPath​

string

Returns​

Promise<{ cert: string; key: string; } | null>

storeSecret()​

storeSecret(path, data): Promise<boolean>

Defined in: services/mcp/OpenBaoSecretsService.ts:188

Store a secret in OpenBao

Parameters​
path​

string

data​

Record<string, unknown>

Returns​

Promise<boolean>

deleteSecret()​

deleteSecret(path): Promise<boolean>

Defined in: services/mcp/OpenBaoSecretsService.ts:229

Delete a secret from OpenBao

Parameters​
path​

string

Returns​

Promise<boolean>

clearCache()​

clearCache(): void

Defined in: services/mcp/OpenBaoSecretsService.ts:268

Clear the secret cache

Returns​

void

isAvailable()​

isAvailable(): Promise<boolean>

Defined in: services/mcp/OpenBaoSecretsService.ts:275

Check if OpenBao is available

Returns​

Promise<boolean>

Interfaces​

Secret​

Defined in: services/mcp/OpenBaoSecretsService.ts:20

Retrieved secret

Properties​

type​

type: SecretType

Defined in: services/mcp/OpenBaoSecretsService.ts:21

value​

value: string

Defined in: services/mcp/OpenBaoSecretsService.ts:22

metadata?​

optional metadata: Record<string, unknown>

Defined in: services/mcp/OpenBaoSecretsService.ts:23

expiresAt?​

optional expiresAt: Date

Defined in: services/mcp/OpenBaoSecretsService.ts:24

OAuth2Token​

Defined in: services/mcp/OpenBaoSecretsService.ts:30

OAuth2 token response

Properties​

accessToken​

accessToken: string

Defined in: services/mcp/OpenBaoSecretsService.ts:31

tokenType​

tokenType: string

Defined in: services/mcp/OpenBaoSecretsService.ts:32

expiresIn​

expiresIn: number

Defined in: services/mcp/OpenBaoSecretsService.ts:33

refreshToken?​

optional refreshToken: string

Defined in: services/mcp/OpenBaoSecretsService.ts:34

scope?​

optional scope: string

Defined in: services/mcp/OpenBaoSecretsService.ts:35

Type Aliases​

SecretType​

SecretType = "api_key" | "oauth2" | "mtls_cert"

Defined in: services/mcp/OpenBaoSecretsService.ts:15

Secret types

Functions​

getOpenBaoSecretsService()​

getOpenBaoSecretsService(): OpenBaoSecretsService

Defined in: services/mcp/OpenBaoSecretsService.ts:295

Get the OpenBao secrets service instance

Returns​

OpenBaoSecretsService