⚙️aidp-user-settings
- ソース
- GitHub で見る ↗
説明
AIDPユーザー設定/プリファレンスを管理します。DataLakeに関するユーザー設定の一覧取得・取得・作成・更新・削除を行います。 次のような場合に使用: ユーザーがAIDPワークベンチのプリファレンス/設定を確認・変更したい場合、またはユーザー設定エントリを管理したい場合。 自己完結型。公式の `aidp user-setting` CLIを優先的に使用し、利用できない場合は `oci raw-request` にフォールバックします。
原文を表示
Manage AIDP user settings / preferences — list, get, create, update, delete a user's settings for the DataLake. Use when the user wants to view or change their AIDP workbench preferences/settings, or manage stored user-setting entries. Self-contained — official `aidp user-setting` CLI preferred, `oci raw-request` fallback.
ユースケース
- ✓ユーザーがプリファレンス/設定を確認したい
- ✓ユーザーがプリファレンス/設定を変更したい
- ✓ユーザー設定エントリを管理したい
本文(日本語訳)
aidp-user-settings — ユーザー設定 & プリファレンス
AIDPユーザー設定エントリの読み取りおよび管理を行います。
自己完結型のスキルであり、MCP や ai-data-engineer-agent は不要です。
エンジンの優先順位は references/aidp-cli-map.md に従い、公式の aidp CLI を優先し、使用できない場合は oci raw-request を使用します。
次のような場合に使用
- 「AIDPの設定やプリファレンスを表示・変更したい」
- 「ユーザー設定を一覧表示 / 取得 / 更新 / 削除したい」
エンジン(CLI優先)
aidp user-setting list <instance-id> --auth api_key --profile DEFAULTaidp user-setting get|create|update|delete <instance-id> …(各コマンドのキーやリクエストボディはaidp help user-settingを参照。create/update には--bodyで JSON を指定)- フォールバック(
oci raw-request):…/20240831/dataLakes/<OCID>/userSettings— 実環境で200確認済み(レークスコープ、2026-06-10) CRUD操作:GET …/userSettings/{key}、POST/PUT/DELETE(create/updateのリクエストボディは、書き込み前にaidp help user-settingまたは実際のデータ読み取りで確認すること)
作成ボディ — CreateUserSettingDetails
CLI: aidp user-setting create <DATALAKE_OCID> --body <JSON>(CLI README「user-setting create」参照)
エンベロープ(SDK create_user_setting_details.py:34-44):
| フィールド(ワイヤー名) | 必須 | 備考 |
|---|---|---|
name |
✅ | ユーザーフレンドリーな設定名 |
isDefault |
✅ | そのタイプのデフォルト設定として指定するフラグ |
data |
✅ | ネストされた SettingData。識別子 type は IAM_USER_CREDENTIAL | GIT_ACCOUNT | OAUTH のいずれか(setting_data.py:18-26) |
data のバリアント(サブクラスモデル + CLI README「user-setting create」):
type |
フィールド(ワイヤー名) | 参照元 |
|---|---|---|
GIT_ACCOUNT |
entityType(PERSONAL_ACCESS_TOKEN)、providerName(GITHUB | BITBUCKET | GITLAB | OCI_DEVOPS)、username、personalAccessToken |
git_account_user_setting.py:77-83、列挙型 …:18-34 |
IAM_USER_CREDENTIAL |
userId、tenancy、region、fingerprint、privateApiKey |
iam_user_credential_user_setting.py:57-64 |
GIT_ACCOUNT の例 —
.aidp/payloads/create-<name>-user-setting.json に保存してから内容を確認すること。
personalAccessToken / privateApiKey は秘密情報であり、ボディ内で渡すのみとし、絶対に出力・返却しないこと:
{
"name": "my_github",
"isDefault": true,
"data": {
"type": "GIT_ACCOUNT",
"entityType": "PERSONAL_ACCESS_TOKEN",
"providerName": "GITHUB",
"username": "<user>",
"personalAccessToken": "<PAT>"
}
}
フィールド名は確認済みです(SDK
attribute_map+ CLI README)。…/userSettingsの GET は実環境で200確認済み(レークスコープ、2026-06-10)。 create後はデータを再読み取りしてラウンドトリップを確認してください。
ワークフロー
list/getで現在の設定を確認する。- create / update / delete の場合は、変更内容を表示してから適用し、再読み取りで確認する。
ガードレール
- 操作は呼び出し元自身の設定に限定すること。
- 明示的な指示がない限り、他のプリンシパルの設定を変更しないこと。
参照
原文(English)を表示
aidp-user-settings — user settings & preferences
Read and manage AIDP user-setting entries. Self-contained: no MCP / ai-data-engineer-agent required.
Engine precedence per references/aidp-cli-map.md — prefer the official aidp CLI, else oci raw-request.
When to use
- "Show / change my AIDP settings or preferences", "list/get/update/delete a user setting".
Engine (CLI-preferred)
aidp user-setting list <instance-id> --auth api_key --profile DEFAULTaidp user-setting get|create|update|delete <instance-id> …(seeaidp help user-settingfor the key/body of each; create/update take a--bodyJSON).- Fallback (
oci raw-request):…/20240831/dataLakes/<OCID>/userSettings— live-verified 200 (lake-scoped, 2026-06-10);GET …/userSettings/{key},POST/PUT/DELETEfor CRUD (confirm the create/update body viaaidp help user-setting/ a live read before writing).
Create body — CreateUserSettingDetails
CLI: aidp user-setting create <DATALAKE_OCID> --body <JSON> (CLI README "user-setting create").
Envelope (SDK create_user_setting_details.py:34-44):
| Field (wire) | Req | Notes |
|---|---|---|
name |
✅ | user-friendly setting name |
isDefault |
✅ | mark this the default for its type |
data |
✅ | nested SettingData; discriminator type ∈ IAM_USER_CREDENTIAL | GIT_ACCOUNT | OAUTH (setting_data.py:18-26) |
data variants (subclass models + CLI README "user-setting create"):
type |
Fields (wire) | Source |
|---|---|---|
GIT_ACCOUNT |
entityType (PERSONAL_ACCESS_TOKEN), providerName (GITHUB|BITBUCKET|GITLAB|OCI_DEVOPS), username, personalAccessToken |
git_account_user_setting.py:77-83, enums …:18-34 |
IAM_USER_CREDENTIAL |
userId, tenancy, region, fingerprint, privateApiKey |
iam_user_credential_user_setting.py:57-64 |
Example (GIT_ACCOUNT) — persist to .aidp/payloads/create-<name>-user-setting.json and confirm first;
personalAccessToken/privateApiKey are secret material — pass in the body, never echo back:
{
"name": "my_github",
"isDefault": true,
"data": {
"type": "GIT_ACCOUNT",
"entityType": "PERSONAL_ACCESS_TOKEN",
"providerName": "GITHUB",
"username": "<user>",
"personalAccessToken": "<PAT>"
}
}
Field names are confirmed (SDK
attribute_map+ CLI README).…/userSettingsGET is live-200 (lake-scoped, 2026-06-10); still re-read after create to confirm the round-trip.
Workflow
list/getto show current settings.- For create/update/delete, show the change and apply it; re-read to confirm.
Guardrails
- Scope to the caller's own settings; don't change another principal's settings without explicit instruction.
References
原文・著作権は Anthropic および各プラグイン作者に帰属します。日本語訳は Claude API による自動翻訳です。