> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vault データ構造

> Vault とクレデンシャルの共通構造。

## Vault オブジェクト

create、get、list、archive エンドポイントで返却されます。

| フィールド          | 型                                     | 説明                                                                      |
| -------------- | ------------------------------------- | ----------------------------------------------------------------------- |
| `id`           | string                                | `vault_` プレフィックス付きの Vault ID                                            |
| `type`         | string                                | 固定値 `"vault"`                                                           |
| `display_name` | string                                | Vault の表示名、最大 255 文字                                                    |
| `metadata`     | object                                | [メタデータオブジェクト](/ja/cloud-agents/api/conventions/schemas#metadata-object) |
| `credentials`  | [Vault クレデンシャル](#vault-credential)の配列 | Vault 作成のレスポンスでのみ返却され、常に空配列。認証情報は独立した credential エンドポイントで管理します          |
| `archived_at`  | string \| null                        | アーカイブ時刻。アクティブな場合は `null`                                                |
| `created_at`   | string                                | 作成時刻                                                                    |
| `updated_at`   | string                                | 最終更新時刻                                                                  |

## Vault クレデンシャル

create credential、list credentials、archive credential の各エンドポイントで返却されます。

| フィールド          | 型                                                 | 説明                                    |
| -------------- | ------------------------------------------------- | ------------------------------------- |
| `id`           | string                                            | `vcred_` プレフィックス付きのクレデンシャル ID         |
| `type`         | string                                            | 固定値 `"vault_credential"`              |
| `vault_id`     | string                                            | 所有する Vault の ID                       |
| `auth`         | [Credential auth オブジェクト](#credential-auth-object) | サニタイズされた認証詳細。シークレットは決して返されない          |
| `display_name` | null                                              | 現在は常に `null`                          |
| `metadata`     | object                                            | 認証情報に保存されるカスタムメタデータオブジェクト。デフォルトは `{}` |
| `archived_at`  | string \| null                                    | アーカイブ時刻。アクティブな場合は `null`              |
| `created_at`   | string                                            | 作成時刻                                  |
| `updated_at`   | string                                            | 最終更新時刻                                |

`token`、`access_token`、`refresh_token`、`client_secret`、`secret_value` を含むクレデンシャルのシークレットは、作成リクエストで受け付けられますが、レスポンスには決して含まれません。

## クレデンシャル作成リクエスト

| フィールド          | 型      | 必須  | 説明                                      |
| -------------- | ------ | --- | --------------------------------------- |
| `auth`         | object | はい  | クレデンシャルの認証詳細                            |
| `display_name` | string | いいえ | 互換性のために受け付けられる。現在は `null` として返され、保持されない |
| `metadata`     | object | いいえ | 認証情報に保存されるカスタムメタデータ。デフォルトは `{}`         |

## Credential auth オブジェクト

### `static_bearer`

| フィールド            | 型      | 必須 | 説明                                   |
| ---------------- | ------ | -- | ------------------------------------ |
| `type`           | string | はい | `static_bearer`                      |
| `mcp_server_url` | string | はい | MCP サーバー URL、最大 2048 文字              |
| `token`          | string | はい | Vault に安全に保存される Bearer トークン。決して返されない |

レスポンスの auth では `token` は省略されます。

### `mcp_oauth`

| フィールド            | 型      | 必須  | 説明                                                     |
| ---------------- | ------ | --- | ------------------------------------------------------ |
| `type`           | string | はい  | `mcp_oauth`                                            |
| `mcp_server_url` | string | はい  | MCP サーバー URL、最大 2048 文字                                |
| `access_token`   | string | はい  | OAuth アクセストークン。決して返されない                                |
| `expires_at`     | string | いいえ | RFC 3339 形式のアクセストークン有効期限                               |
| `refresh`        | object | いいえ | リフレッシュ設定。`refresh_token` および `client_secret` を含まずに返される |

### `environment_variable`

| フィールド          | 型      | 必須  | 説明                                        |
| -------------- | ------ | --- | ----------------------------------------- |
| `type`         | string | はい  | `environment_variable`                    |
| `secret_name`  | string | はい  | 環境変数名。`[A-Za-z_][A-Za-z0-9_]*` に一致する必要がある |
| `secret_value` | string | はい  | シークレットの値。決して返されない                         |
| `networking`   | object | いいえ | 互換性のために受け付けられる。現在は何も行わず、空オブジェクトとして返される    |

## 関連項目

<CardGroup cols={2}>
  <Card title="Vaults" icon="key" href="/ja/cloud-agents/vaults">
    シークレットを安全に保存し、Agent Session に注入する。
  </Card>
</CardGroup>
