Subscribing to event endpoints

After discovering an event endpoint that is suitable for use with your application, you can subscribe to it in a self-service manner in the Catalog by generating access credentials.

Generating access credentials for an event endpoint

To generate access credentials for an event endpoint that has not been configured with approval controls, complete the following steps.

  1. Log in to the Event Endpoint Management UI by using your login credentials.
  2. In the navigation pane, click Catalog.
  3. Select an event endpoint from the list by clicking the event endpoint name.
  4. Click Generate access credentials in the Topic information view.

  5. Follow the instructions to request access: provide your contact details, and click Generate.

    The Access credentials pane is displayed and presents your subscription credentials. This credential is a SASL username and password, which uniquely identifies you and your usage of this event endpoint. These credentials must be used when accessing the event source through the Event Gateway.

    Note: The contact information is a free text field, and the details provided can be used by the owners of the event endpoint to contact you as required, for example, in case of maintenance or event endpoint deprecation. Providing an email address is recommended.

  6. Copy your username and password values, or click Download credentials to download your generated credentials as a JSON file for future use and reference.

    Your application will require these credentials to access the event source through the Event Gateway.

    Important: The credentials generated for you are shown one time. They cannot be retrieved later. Ensure you save the access credentials and store them in a secure location.

Note: The Generate access credentials button is only available for event endpoints that are still accepting new subscriptions. The owner of the event endpoint controls if subscriptions are offered in the Catalog.

Requesting access to an event endpoint

If an event endpoint has been configured with approval controls, you need to create a request for permission to subscribe to that event endpoint.

To create a request to subscribe to an event endpoint that has approval control enabled, complete the following steps.

  1. In the catalog, select the topic that you want to work with.
  2. Select the option that you want to subscribe to.
  3. Click Request Access. The Request access window is displayed.
  4. In the Contact field, provide a contact name.
  5. In the Justification field, provide a description to explain why you want this subscription.
  6. Click Request.

Your request will be reviewed by the owner of the event endpoint.

Note: You can only have one request for a subscription open at a time against an option. If Request access is greyed out, a request for that option is pending a review by the owner of the event endpoint.

Access approvals and rejections

Approved requests

If your request is approved, the Request access button changes to Generate credentials and you can then proceed to generate credentials by following the usual process.

Rejected requests

If your request is rejected, then Request access is reset and you can submit a new request.

Event Endpoint Management 11.4.1 icon Mutual TLS

If the event endpoint option is configured with an mTLS control, then to access the endpoint you must present a client certificate that meets the requirements of the mTLS control.

  • Your client certificate must be signed by a well-known certificate authority. If your certificate is self-signed, then the CA certificate must be uploaded when the mTLS control is created.
  • Your client certificate subject fields must meet the requirements of the mTLS control. Click the tooltip next to mTLS requirements to see these requirements.

If the mTLS Control uses SASL credentials, then a username and password is generated for you.

If the mTLS Control is using Subject Identifying Fields, then when you click Subscribe you must provide the subject fields of your client certificate. The subject fields are used to identify you when you access the endpoint. You can upload a .pem file of your client certificate to autofill these fields. The certificate subject field values that you provide must be unique, you cannot use the same client certificate in multiple subscriptions.

Next steps

After creating a subscription, you can access the event endpoint you subscribed to through the Event Gateway. The Catalog contains sample code and connection information to help you configure your application to connect to an event endpoint.

You can also view the event endpoints you have access to, and remove any subscriptions you no longer require.