AS AgentScopeAPI 手册 / API Reference

VaultService

@Service @Transactional public class VaultService
源码Source io/agentscope/builder/web/managed/service/VaultService.java:35–236

Vault 服务,承载智能体的部署、调度与服务化运行。位于 io.agentscope.builder.web.managed.service 包。核心成员包括 list、get、create、delete、listCredentials、addCredential。

CRUD for credential vaults with encrypted secret storage.

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
CreateVaultRequest记录record
承载创建 Vault 请求数据的记录类型。
Request body for creating a vault.
AddCredentialRequest记录record
承载添加凭证请求数据的记录类型。
Request body for adding a credential.

字段摘要Field Summary

字段Field类型Type说明Description
RESOURCE_TYPE
staticfinal
String
资源类型字段。
Resource-type key used for `ResourceAccessService` share grants.

构造器摘要Constructor Summary

构造器Constructor说明Description
public VaultService(VaultEntityRepository vaultRepository, VaultCredentialEntityRepository credentialRepository, VaultCrypto vaultCrypto, ManagedJsonHelper jsonHelper, ResourceAccessService resourceAccessService)
初始化 `VaultService` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public List<VaultDto> list(String ownerId)
设置列表。
Lists vaults owned by the user.
public VaultDto get(String ownerId, String vaultId)
按条件读取数据。
Returns a single vault when owned by, or shared (at least RUN) with, the caller.
public VaultDto create(String ownerId, CreateVaultRequest request)
创建并返回实例。
Creates a vault.
public void delete(String ownerId, String vaultId)
删除数据。
Deletes a vault and all credentials.
public List<VaultCredentialDto> listCredentials(String ownerId, String vaultId)
列出凭证。
Lists credential metadata for a vault (no plaintext).
public VaultCredentialDto addCredential(String ownerId, String vaultId, AddCredentialRequest request)
添加凭证。
Adds an encrypted credential to a vault.
public void deleteCredential(String ownerId, String vaultId, String credentialId)
删除凭证。
Deletes a credential from a vault.
public String getDecryptedSecret(String ownerId, String credentialId)
获取已解密密钥。
Returns decrypted secret JSON for internal MCP injection.
public List<ResourceShareDto> listShares(String ownerId, String vaultId)
列出 `listShares`。
Lists share grants on a vault.
public ResourceShareDto share(String ownerId, String vaultId, String granteeType, String granteeId, Tier tier)
执行 `share` 方法。
Shares a vault with a user or the whole workspace.
public void unshare(String ownerId, String vaultId, String shareId)
执行 `unshare` 方法。
Revokes a share grant on a vault.

字段详情Field Detail

RESOURCE_TYPE

public static final String RESOURCE_TYPE
staticfinal

资源类型字段。声明为 public static final String RESOURCE_TYPE。

Resource-type key used for ResourceAccessService share grants.

源码Source io/agentscope/builder/web/managed/service/VaultService.java:40

构造器详情Constructor Detail

VaultService

public VaultService(VaultEntityRepository vaultRepository, VaultCredentialEntityRepository credentialRepository, VaultCrypto vaultCrypto, ManagedJsonHelper jsonHelper, ResourceAccessService resourceAccessService)

初始化 VaultService 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
vaultRepositoryVaultEntityRepositoryvault 仓库(类型 `VaultEntityRepository`)。The vault repository.
credentialRepositoryVaultCredentialEntityRepository凭证仓库(类型 `VaultCredentialEntityRepository`)。The credential repository.
vaultCryptoVaultCryptovault Crypto(类型 `VaultCrypto`)。The vault crypto.
jsonHelperManagedJsonHelperJSON Helper(类型 `ManagedJsonHelper`)。The json helper.
resourceAccessServiceResourceAccessService资源访问服务(类型 `ResourceAccessService`)。The resource access service.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:54–65

方法详情Method Detail

list

public List<VaultDto> list(String ownerId)

设置列表。

Lists vaults owned by the user.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
返回Returns List<VaultDto>
返回列出。Returns list.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:68–73

get

public VaultDto get(String ownerId, String vaultId)

按条件读取数据。

Returns a single vault when owned by, or shared (at least RUN) with, the caller.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
返回Returns VaultDto
返回VaultDto。Returns vault dto.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:76–79

create

public VaultDto create(String ownerId, CreateVaultRequest request)

创建并返回实例。

Creates a vault.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
requestCreateVaultRequest请求(类型 `CreateVaultRequest`)。The request.
返回Returns VaultDto
返回VaultDto。Returns vault dto.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:82–95

delete

public void delete(String ownerId, String vaultId)

删除数据。

Deletes a vault and all credentials.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:98–102

listCredentials

public List<VaultCredentialDto> listCredentials(String ownerId, String vaultId)

列出凭证。

Lists credential metadata for a vault (no plaintext).

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
返回Returns List<VaultCredentialDto>
返回列出。Returns list.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:105–111

addCredential

public VaultCredentialDto addCredential(String ownerId, String vaultId, AddCredentialRequest request)

添加凭证。

Adds an encrypted credential to a vault.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
requestAddCredentialRequest请求(类型 `AddCredentialRequest`)。The request.
返回Returns VaultCredentialDto
返回VaultCredentialDto。Returns vault credential dto.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:114–136

deleteCredential

public void deleteCredential(String ownerId, String vaultId, String credentialId)

删除凭证。

Deletes a credential from a vault.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
credentialIdString凭证标识(类型 `String`)。The credential id.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:139–155

getDecryptedSecret

public String getDecryptedSecret(String ownerId, String credentialId)

获取已解密密钥。

Returns decrypted secret JSON for internal MCP injection.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
credentialIdString凭证标识(类型 `String`)。The credential id.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:158–170

listShares

public List<ResourceShareDto> listShares(String ownerId, String vaultId)

列出 listShares。

Lists share grants on a vault.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
返回Returns List<ResourceShareDto>
返回列出。Returns list.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:173–177

share

public ResourceShareDto share(String ownerId, String vaultId, String granteeType, String granteeId, Tier tier)

执行 share 方法。

Shares a vault with a user or the whole workspace.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
granteeTypeStringgrantee 类型(类型 `String`)。The grantee type.
granteeIdStringgrantee 标识(类型 `String`)。The grantee id.
tierTiertier(类型 `Tier`)。The tier.
返回Returns ResourceShareDto
返回ResourceShareDto。Returns resource share dto.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:180–185

unshare

public void unshare(String ownerId, String vaultId, String shareId)

执行 unshare 方法。

Revokes a share grant on a vault.

参数Parameters
名称Name类型Type说明Description
ownerIdString所有者标识(类型 `String`)。The owner id.
vaultIdStringvault 标识(类型 `String`)。The vault id.
shareIdStringshare 标识(类型 `String`)。The share id.
源码Source io/agentscope/builder/web/managed/service/VaultService.java:188–191

嵌套类详情Nested Class Detail

CreateVaultRequest

public record CreateVaultRequest(String displayName, Map<String, Object> metadata)

承载创建 Vault 请求数据的记录类型。位于 io.agentscope.builder.web.managed.service 包。核心成员包括 displayName、metadata。

Request body for creating a vault.

AddCredentialRequest

public record AddCredentialRequest(String type, String label, String target, String secret)

承载添加凭证请求数据的记录类型。位于 io.agentscope.builder.web.managed.service 包。核心成员包括 type、label、target、secret。

Request body for adding a credential.

基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.