Skip to main content

Prophecy secrets

A secret is stored sensitive data such as passwords, API keys, or certificates. Prophecy includes a built-in secret manager to store secrets securely and allow Prophecy Automate to access them at runtime. This prevents credentials from being hardcoded or shared in plain text.

Secret typeDescriptionExample use case
TextA string value.Access token value
BinaryA file that you upload.SSL certificate
Username & PasswordTwo-field credential for a username and password.Basic authentication for RestAPIs
M2M OAuthMulti-field credential used for client credential authentication.REST APIs using bearer tokens

Access control

Access to secrets is related to fabric access.

  • Secrets are tied to the fabric where they’re created.
  • Anyone with access to that fabric can reference its secrets in projects.
  • The secret value is never visible, even to the user who created it.

Create a secret

To add a new secret to a fabric:

  1. From the left sidebar, open the Metadata page.

  2. Open the fabric where you want to store the secret.

  3. Go to the Secrets tab.

  4. Click + Add Secret.

  5. In the dialog, choose the Secret Type.

    Secret TypeParameters
    Text
    • Name: Label to identify the secret
    • Value: String value
    Binary
    • Name: Label to identify the secret
    • Value: Upload a file (such as a certificate)
    Username & Password
    • Name: Label to identify the secret
    • Username: Username for authentication
    • Password: Password for authentication
    M2M OAuth
    • Name: Label to identify the secret
    • Client ID: OAuth client identifier
    • Client Secret: OAuth client secret key
    • Auth URL: OAuth authorization server endpoint
    • Scope (Optional): OAuth permissions scopes
  6. Click Create to save it to the fabric.

Reference a secret

Secrets are often used to hide credentials in connections.

  1. Create a new connection.
  2. In fields that require credentials, a secret picker appears automatically.
  3. If the secret doesn’t exist yet, click the New Secret button, which opens the fabric’s Add Secret dialog.
  4. Once saved, the secret will appear in the picker.
  5. Select it, and Prophecy will validate the connection securely using that secret.