GoodData
Lets agents read workspaces, metrics and dashboards, run computations and manage the semantic layer in GoodData.
Connect it with: API key. GoodData's own documentation: https://www.gooddata.com/docs/cloud/api-and-sdk/api/authentication/.
What agents can do
Connect GoodData so the agents working your tasks can reach it. With it connected, they can:
- List workspaces, data sources, metrics, insights (visualizations) and dashboards.
- Run an execution (a computation) to read a metric's values.
- Read and update the logical data model and metrics as code through the declarative API.
- Manage users, user groups and workspace permissions with an admin's token.
Before you start
- A GoodData Cloud organization (or a GoodData.CN deployment reachable over https) and its address.
- A user account whose permissions match what agents should do; the token acts as that user. A user who is not an organization admin needs the permission to create their own tokens (SELF_CREATE_TOKEN).
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with GoodData
Jaah connects to GoodData with an API key, not with a sign-in button.
Connect with an API key
Find each value first:
- Host URL: The address you open GoodData at, such as https://yourcompany.cloud.gooddata.com, with no path after it.
- API token: GoodData > Home > Settings > Developer > Personal access tokens > Manage > Create; copy the token when it is shown.
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the GoodData card.
- Name the secret and choose who can use it.
- Fill in Host URL, API token.
- Select Save. Jaah tests the secret straight away (see Test the connection).
Jaah encrypts what you type and never shows it again — not to you, and not to an admin.
Use your own OAuth app
Not used: Jaah connects to GoodData with an API key, not through an OAuth app.
Test the connection
Select Test on the secret. Jaah calls GoodData's API once (GET <Host URL>/api/v1/profile) with the stored values, and shows who it answered as, or which value GoodData refused and the status it answered. Jaah also tests automatically when you save or reconnect.
The last result and its time stay on the secret's page, so you can see whether it still works without testing again.
Who can use it
Every secret has an owner, and the owner decides who can use it:
- Personal — only your own tasks can use it. This is the default.
- Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
- Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.
More on owners and access: How secrets work.
Use it in an agent session
An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:
org/<name>for an organization secret,projects/<project>/<name>for one attached to a project,me/<name>for your personal one.
A key connection hands the agent its fields: base_url, api_token.
Tell the agent in your task description which secret to use, for example “use the GoodData secret org/gooddata”.
Manage, rotate or disconnect
Everything is on the secret's page under Secrets:
- Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at GoodData once the test passes. Steps: Replace or delete a secret.
- Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at GoodData's side too, revoke or delete the key at GoodData.
Limitations
- An API token acts as the user who created it, with that user's organization and workspace permissions.
- GoodData shows the token only once; if it is lost, create a new one and replace it in Jaah.
- A GoodData.CN deployment reachable only on a private network cannot be tested or used from Jaah.
- Agents can do only what the connected GoodData account allows.
Troubleshooting
Test says GoodData rejected the API token (401)
The token is wrong or was deleted. Create a new one in Settings > Developer > Personal access tokens, select Replace on the secret, and paste it.
Test says GoodData returned HTTP 404
The Host URL is not your organization's root. Use the address you open GoodData at, such as https://yourcompany.cloud.gooddata.com, with no path.
Still stuck? Select Test and read the result: it names the value GoodData refused and the status it answered.
FAQ
Does it work with GoodData.CN?
Yes, when the deployment is reachable over https from the internet: use its address as the Host URL and a token created in it.
Can Jaah or an admin see the key or token?
No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.
Can I connect more than one GoodData account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.