Aidp User Settings

by oracle-samples90b42d6c24d4No licenseListed Oct 8, 2026Updated Oct 8, 2026

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.

Instructions onlyProductivity & Workflow
AI-generated overview

Manage AIDP DataLake user settings and preferences via the aidp CLI or oci raw-request fallback.

What it does
This skill guides an agent through listing, getting, creating, updating and deleting AIDP user-setting entries for a DataLake. It documents the CLI commands, the REST endpoint used as a fallback, and the required create body fields for setting types such as GIT_ACCOUNT and IAM_USER_CREDENTIAL. It also covers re-reading settings after a change to confirm the result and handling secret material without echoing it back.
When to use it
Use it when a user wants to view or change their AIDP workbench settings or preferences, or manage stored user-setting entries. It fits requests to list, get, create, update or delete a user setting.
Requirements
Requires access to the AIDP environment: the official aidp CLI with an authenticated profile, or the oci CLI for the raw-request fallback. Network access to the AIDP DataLake REST API and a DataLake OCID are needed, along with credentials for the relevant setting types. It ships no scripts; it is instructions only.

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 DEFAULT
  • aidp user-setting get|create|update|delete <instance-id> … (see aidp help user-setting for the key/body of each; create/update take a --body JSON).
  • Fallback (oci raw-request): …/20240831/dataLakes/<OCID>/userSettings — live-verified 200 (lake-scoped, 2026-06-10); GET …/userSettings/{key}, POST/PUT/DELETE for CRUD (confirm the create/update body via aidp 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)ReqNotes
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"):

typeFields (wire)Source
GIT_ACCOUNTentityType (PERSONAL_ACCESS_TOKEN), providerName (GITHUB|BITBUCKET|GITLAB|OCI_DEVOPS), username, personalAccessTokengit_account_user_setting.py:77-83, enums …:18-34
IAM_USER_CREDENTIALuserId, tenancy, region, fingerprint, privateApiKeyiam_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:

json
{  "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). …/userSettings GET is live-200 (lake-scoped, 2026-06-10); still re-read after create to confirm the round-trip.

Workflow

  1. list/get to show current settings.
  2. 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

  • references/aidp-cli-map.md · references/oci-raw-request.md · references/rest-endpoint-map.md

Source and attribution

Source:oracle-samples/oracle-aidp-samplesinai/claude-code-plugins/oracle-ai-data-platform-workbench-engineer-agent/skills/aidp-user-settingsat commit90b42d6

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

More from oracle-samples/oracle-aidp-samples

Aidp Workspace Admin

oracle-samples

Provision and inspect AIDP DataLake instances and workspaces, including private-network workspaces attached to a customer VCN/subnet. Use when the user wants to create/list/get a workspace or DataLake instance, set up a new (e.g. private) AIDP environment, or replicate a customer setup. Create/delete are guarded — confirm before any provisioning.

Awaiting classificationOct 8, 2026

Aidp Volumes

oracle-samples

Work with AIDP volumes — list volumes, browse files inside a volume, upload/download via the PAR flow, and create directories. Use when the user mentions volumes, needs to stage large/binary files, or move data in/out of a volume (distinct from the workspace filesystem). Control-plane via the official `aidp` CLI.

Awaiting classificationOct 8, 2026

Aidp Verified Queries

oracle-samples

Maintains a repository of validated question-to-Spark-SQL pairs so an agent reuses trusted SQL before writing new queries.

Data & AnalyticsOct 8, 2026

Aidp Spark Optimization

oracle-samples

Guides Apache Spark 3.5.0 performance tuning: partitions, shuffle, joins, skew, memory, file layout, AQE and Delta Lake.

Data & AnalyticsOct 8, 2026

Aidp Semantic Model

oracle-samples

Maintains a .aidp/semantic.md business-meaning layer defining metrics, joins, synonyms and value dictionaries for NL-to-SQL grounding.

Data & AnalyticsOct 8, 2026

Aidp Roles Access

oracle-samples

Manages AIDP roles and access: list roles, add or remove members, and grant or revoke per-resource permissions.

SecurityOct 8, 2026