Version 2 of BE/DSE configuration

Audience: API developers

Updating the configuration

Note that the release making this update possible is backwards compatible. There is no explicit need to update your configuration right now, but doing so will allow you and your organization to make use of new features will be implemented in business-events in the future.

"UseForClients" are removed from each authentication method.

Old:
{
  "AuthorizationType": "BearerToken",
  "Token": "...",
  "UseForClients": [ "client-a", ... ]
}

New:
{
  "AuthorizationType": "BearerToken",
  "Token": "..."
}

The clients and authentications are now defined in separate lists in the configuration.
A client is connected to an authentication method by the field "Authentication" in the client definition. This entry should match the Id field of the authentication name.

{
    "ConnectionString": "<BusinessEventsConnectionString>",
    ...
    "Clients": [
        {
            "Name": "client-a",
            "Authentication": "client-a-authentication"
        },
        ...  
    ],
    "Authentications": [
        {
            "Id": "client-a-authentication",
            "AuthorizationType": "Basic",
            "Username": "polyrythm",
            "Password": "beat210"
        }
    ]
  }

The client object also supports configuration one more headers which will be sent to the client with each subscription.

 {
     "Name": "client-a",
     "Authentication": "client-a-authentication",
     "RequestHeaders": { 
         "header-a": "value-a",
         "header-b": "value-b"
      }
 },

If you are unsure about how to update your configuration you are welcome to contact any developer in Nexus Link or the Nexus Link support.