DocumentaciónHelp

Access credentials

Choose how the platform authenticates to your system and store its key, token or username encrypted.

On this page

Credentials let the platform connect to your system's API, for example to test the connection with the Test button. They are stored encrypted and never shown again: after you save them, you'll only see a hint with their last characters.

Don't confuse these credentials with the webhook's Signing secret: credentials let the platform access your system; the secret lets your system sign what it sends to the platform.

Before you start

  • You need the Administrator role.

  • Ask the system owner for a read-only credential, if the system allows it. The platform doesn't need write permissions.

Authentication types

In Authentication, inside the integration form, choose an option. Each one shows its own fields:

Option

Fields

No authentication

None

API key

API key and Header name (optional), for example X-API-Key

Bearer token

Token

Username and password

Username and Password

OAuth 2.0 (client credentials)

Client ID, Client secret and Token URL

Below the fields you'll see: They're stored encrypted and never shown again; you'll only see a hint of the last characters.

If you leave Header name (optional) empty in API key, the key is sent in the X-API-Key header.

With OAuth 2.0 (client credentials), the platform stores the data encrypted, but for now Test queries your system without authenticating. If your system requires authentication for its health path, the test will respond with a code such as 401.

Save the credentials when creating

  1. In Settings → Integrations, press New integration.

  2. Choose the type in Authentication and fill in its fields.

  3. Complete the rest of the form and press Save.

Change or keep the credentials when editing

  1. On the integration's card, press the Edit button (pencil).

  2. Under Authentication you'll see Saved credential: with its hint and Leave the fields blank to keep it. The fields appear empty with the text Leave blank to keep.

  3. Do one of the following:

    • Keep it: leave the fields blank.

    • Replace it: type the new credential in the fields.

    • Change the type: choose another type in Authentication. You'll see You changed the authentication type: enter the new credentials. Fill in the new type's fields: the form doesn't require it, but if you leave them empty the previous credential stays saved, and it doesn't work for the new type.

    • Delete it: choose No authentication. You'll see Saving deletes the stored credential.

  4. Press Save.

When you change the authentication type, whatever you had typed in the fields is discarded. If you choose the wrong type, choose the right one again and type it again.

Nobody can see a credential after it is saved, not even an administrator. If you lose it, generate a new one in your system and replace it here.

What happens next

The integration's card shows the chosen type and the credential hint in Authentication. To check that it works, use Test the connection.

If the test responds The stored credentials can't be decrypted (the master key changed). Enter them again., edit the integration and type the credential again.

Related

Search SofIA Governance

Type at least 2 characters to search SofIA Governance.

↑↓ to navigate · Enter to open · Esc to close