Credentials

A credential is a secret that Nuvelics uses to sign in to another service for you: an API key for a news wire, a token for X, an application password for WordPress. Credentials stores them once, so a data source or an integration can use one without anyone pasting the secret again.

Every member can open the list and a credential's details, Viewers included, but a secret is never shown again once saved. Adding, editing and deleting a credential need the Owner or Admin role (the credential:manage permission); for anyone else those controls are missing. The page sits under Discovery in the sidebar. See Roles and permissions.

Add a credentialCopy Anchor Link

1. Open Credentials and choose Add Credential. The Add Credential form opens.
2. Enter a Name, which is required.
3. Choose a Type. The list has two groups:
   • Vendor presets, which ask for exactly what that vendor issues: for example AP Media (an API key), Reuters (a client ID and secret), AFP (client ID, client secret, username and password), X (a bearer token) or WordPress (a username and application password). Each field has a hint saying where to find it.
   • Generic — for a vendor without a preset above: API Key (sent as a header, query parameter or path segment), HTTP Basic (a username and password) or HTTP Bearer (a bearer token in the Authorization header).
4. Fill in the fields and choose Create Credential.

A Credential created message appears. Use the credential from a data source's Credential field; see Data Sources.

Find a credentialCopy Anchor Link

The list shows the Name, Type, Health, Last checked and Updated. Search with Search by name…, or choose + Add filter for Scheme or Updated. An empty page says No credentials yet.

Health is Healthy, Unhealthy or Unknown, and Last checked says when. It comes from Nuvelics using the credential, for example a harvest, a notification or a delivery, so a credential that has never been used reads Never under Last checked. Unhealthy stays, with its Last checked, until the use that failed succeeds again. When a credential is unhealthy, open it: its page shows the last error.

Change or replace a credentialCopy Anchor Link

1. Open the credential and choose Edit.
2. Change the Name, or for a vendor preset any of its non-secret fields. Secrets are not shown. Leave a secret field blank to keep the stored value.
3. To change the secret of a generic credential, turn on Replace secret and enter the new values.
4. Choose Save. A Changes saved message appears.

If someone changed the credential after you opened it, you are asked to reload and try again.

Delete a credentialCopy Anchor Link

Choose Delete from the row's Credential actions menu or from the credential's page, and confirm. Deleting is permanent. A credential still attached to a data source cannot be deleted: the page says "This credential is attached to a data source — detach it from its data source(s) first."

Other ways to manage credentialsCopy Anchor Link

• CLI: nuvelics credential.
• API: Credentials.
• The data source types and the credential each needs: Data source types.