Authentication

Most APIs require authentication. In Kubme, you choose a method for the connector, then add one or more credentials (your access), only one of which is active.

Methods

Choose it at the wizard's Authentication step (see Catalog connectors). After an OpenAPI import, it is already set.

Adding a credential

Save the connector first.
At the Authentication step, click Add credential.
Give it a Name ("Production", "Test account"), and fill in the method's fields.
Leave Activate after creation checked so it is used right away.

API Key

Location: Header or Query parameter;
Prefix: the name of the header or parameter (for example X-API-Key). If empty, Kubme uses api_key;
Token: the value sent.

A "Bearer" token

Location Header, Prefix Authorization, Token Bearer your-token.

HTTP Basic

Username and Password.

OAuth2

Grant type:
Client Credentials: server to server, with no user involved;
Authorization Code: the user signs in with the provider and authorizes Kubme.
Client ID, Client Secret, Token URL;
Authorization URL (Authorization Code);
Scopes, separated by spaces;
Advanced options: the client authentication method (In the body or Basic header) and extra authorization parameters.

With Authorization Code, Kubme shows a Redirect URI: copy it and register it in the provider's OAuth application. Then click Connect to authorize Kubme. If the window does not open, allow pop-ups for Kubme.

The OAuth2 connection panel shows the status: Account connected, Account not connected or Re-authorization needed (when the scopes have changed). In that last case, click Reconnect.

Managing credentials

Only one credential is Active: it is used for every call. Options menu › Activate to switch.
Edit: secrets are shown masked. Replace lets you enter a new one, and a field left empty keeps the old value.
Delete: not possible for the active credential. Activate another one first.

Without an active credential, Kubme warns you that the connector cannot call the API.

Security

Your secrets stay safe

Credentials are stored separately from the connector's configuration. Secrets (passwords, tokens, client secrets) are never sent back to the browser, and they are not included when you export a connector.

Once the credential is active, test your actions at the Preview step.

Made with