TIBCO Cloud™ Messaging Client Configuration File
The client configuration file contains all the information client applications need to connect to TIBCO Cloud Messaging securely. Download the client configuration file using the roles REST API or user interface.
Note: TIBCO Cloud Messaging samples require a client configuration file to run.
Description of Fields
When you generate a configuration, the services claim of the role determines which fields are present. The result will only include fields required by services listed in the services claim.
| Field | Service | Description |
|---|---|---|
| tcm_authentication_key | ems, eftl, ftl, pulsar | TIBCO Enterprise Message Service™, TIBCO eFTL™, TIBCO FTL® and Apache Pulsar™ applications must use tcm_authentication_key as the password when connecting to TIBCO Cloud Messaging. The tcm_authentication_key is a JSON Web Signature (JWS) which encodes the claims of the role associated with the configuration file. |
| tcm_authentication_id | eftl, ftl | TIBCO FTL and TIBCO eFTL applications must use tcm_authentication_id as the username when connecting to TIBCO Cloud Messaging. |
| eftl_url | eftl | TIBCO eFTL applications must use eftl_url as the eFTL server URL when connecting to TIBCO Cloud Messaging. To use the eFTL REST API, first replace the scheme wss with https. |
| ftl_url | ftl | TIBCO FTL applications must use ftl_url as the FTL server URL when connecting to TIBCO Cloud Messaging. |
| ftl_application | ftl | TIBCO FTL applications must use ftl_application as the application name when connecting to TIBCO Cloud Messaging. |
| ftl_certificate | ftl | TIBCO FTL applications must supply ftl_certificate as the server certificate when connecting to TIBCO Cloud Messaging for server verification to work. The value of ftl_certificate is a PEM string encoded to fit on a single line. Replace the ‘\n’ substring with a newline character to obtain a legal PEM string. |
| ems_username | ems | TIBCO Enterprise Message Service applications must use ems_username as the username when connecting to TIBCO Cloud Messaging. The value of ems_username is the name of the role associated with the configuration. |
| ems_server | ems | TIBCO Enterprise Message Service must use ems_server URLs when connecting to TIBCO Cloud Messaging. The value of ems_server is a pair of fault-tolerant URLs. |
| pulsar_url | pulsar | Apache Pulsar applications must use pulsar_url as the Pulsar broker URL when connecting to TIBCO Cloud Messaging. |
| pulsar_namespace | pulsar | Apache Pulsar applications must use pulsar_namespace as elements in a fully-qualified Pulsar topic URL. The value of pulsar_namespace is a Pulsar tenant/namespace tuple. |
| kafka_broker | kafka | Apache Kafka® must use kafka_broker as the Kafka broker address when connecting to TIBCO Cloud Messaging. |
| kafka_username | kafka | Apache Kafka must use kafka_username as the SASL username when connecting to TIBCO Cloud Messaging. The value of kafka_username is a Pulsar tenant/namespace tuple. |
| kafka_password | kafka | Apache Kafka must use kafka_password as the SASL password when connecting to TIBCO Cloud Messaging. The value of kafka_password is the value of tcm_authentication_key with the string token: added as a prefix. |