Login 24/7 Support Community

Tyk Identity Broker Configuration Options

The Tyk Identity Broker (TIB) is configured through two files: The configuration file tib.conf and the profiles file profiles.json. TIB can also be managed via the TIB REST API for automated configurations.

The tib.conf file

 "Secret": "test-secret",
 "HttpServerOptions": {
   "UseSSL": true,
   "CertFile": "./certs/server.pem",
   "KeyFile": "./certs/server.key"
 "BackEnd": {
   "Name": "in_memory",
   "IdentityBackendSettings": {
     "Hosts" : {
         "localhost": "6379"
     "Username": "",
     "Password": "",
     "Database": 0,
     "EnableCluster": false,
     "MaxIdle": 1000,
     "MaxActive": 2000,
 "UseSSL": false,
 "SSLInsecureSkipVerify": false
 "TykAPISettings": {
   "GatewayConfig": {
     "Endpoint": "http://{GATEWAY-DOMAIN}",
     "Port": "8080",
     "AdminSecret": "352d20ee67be67f6340b4c0605b044b7"
     "DashboardConfig": {
       "Endpoint": "http://{DASHBOARD-DOMAIN}",
       "Port": "3000",
       "AdminSecret": "12345"

The various options for tib.conf file are:


The REST API secret to configure the Tyk Identity Broker remotely.


Set this to true to turn on SSL for the server, this is highly recommended.


The path to the key file for this server, required for SSL.


The path to the certificate file for this server, required for SSL.


TIB is quite modular and different back-ends can be generated quite easily. By default, TIB will store profile configurations in memory, which does not require any new configuration.

For Identity Handlers that provide token-based access, it is possible to enforce a “One token per provider, per user” policy, which keeps a cache of tokens assigned to identities in Redis, this is so that the broker can be scaled and share the cache across instances.

Since profiles are unlikely to change often, profiles are kept in-memory, but can be added, removed and modified using an API for automated setups if required.


If you are using multiple databases (not supported in Redis cluster), let TIB know which DB to use for Identity caching.


The username for Redis AUTH, if used (recommended).


The password for your Redis AUTH Username.


Add your Redis hosts here as a map of hostname:port. Since TIB uses the same cluster driver as Tyk, it is possible to have TIB interact with your existing Redis cluster if you enable it.


Max idle connections to Redis.


Max active Redis connections.


If you are using Redis cluster, enable it here to enable the slots mode.


If you are using a TLS protected Redis enable to connect.


This option is available from TIB v0.4.0


Allows usage of self-signed certificates when connecting to an encrypted Redis database.


This option is available from TIB v0.4.0


This section enables you to configure the API credentials for the various Tyk Components TIB is interacting with.


The hostname of the Tyk Gateway (this is for token generation purposes).


The port to use on the Tyk Gateway host.


For HTTP or HTTPS endpoints, you do need need to specify the default ports (80 and 443) for this setting. These two ports are handled automatically.


The API secret for the Tyk Gateway REST API.


The hostname of your Dashboard (Advanced API).


The port of your Advanced API.


The high-level secret for the Advanced API. This is required because of the SSO-nature of some of the actions provided by TIB, it requires the capability to access a special SSO endpoint in the Advanced API to create one-time tokens for access.