Secret manager

Secret manager is a central storage for your third-party secrets, such as credentials, API keys, and secrets needed by OAuth authentication. By storing your secrets here, you'll avoid having to define them separately for each event driven integration.

You must have rights to the Secret object type.

Add a secret

  1. Click Add New.

  2. In the Name field, enter the technical name of the secret that you refer to in an event driven integration (EDI) configuration. This field is mandatory. The name is unique, meaning you cannot have multiple secrets with the same name.

    In addition to letters and numbers, you can use dash (-), underscore (_), and period (.).

    In the Description field, you can explain what this secret is used for.

  3. Depending on the type of secret you're adding, see the below table for filling in the Authentication ID and Secret fields. To add the secret, first select Set secret. In the table, you can also see how to refer to each type of authentication in your EDI configuration.

    Table 1. Authentication types
    Type Authentication ID Secret Reference in EDI request's authentication object
    Basic or digest Username Password 
    {
  "type": "basic",
  "secrets_ref": "<name>"
}
    OAuth Client ID Client secret 
    {
  "type": "oauth",
  "secrets_ref": "<name>"
}
    Header key - Secret 
    {
  "x-api-key": "{secrets.<name>}"
}

    For an OAuth secret, also enter the access token URL in the OAuth access token URL field.

  4. Save your changes.