- 3 Minutes to read
- 3 Minutes to read
Keycloak is an open-source identity and access management (IAM) solution. It provides a robust set of features for user authentication, authorization, and single sign-on (SSO) capabilities, allowing organizations to secure their applications and services by managing user identities, roles, and permissions in a centralized and scalable manner.
For all available metrics and attributes, please refer to our website.
In order to obtain access to the API, you will need to provide your server, realm name, client ID, and client secret.
You can't get client_secret for public clients, please check if your client has 'access_type' = 'confidential'.
- Go to CLIENTS section of your realm admin panel
(<protocol>://<host>:<port>/auth/admin/master/console/#/realms/<your realm>/clients/<your client code>)
- Change Access Type to confidential and save.
- Go to the Credentials tab.
- Make sure that 'Client Authenticator' = 'Client Id and Secret'. This is your client secret.
More informaiton about authorization of your Keycloask account can be found here.
Client vs Realm
Realm manages a set of users, credentials, roles, and groups. A user belongs to and logs into a realm. Realms are isolated from one another and can only manage and authenticate the users that they control.
Clients are entities that can request Keycloak to authenticate a user. Most often, clients are applications and services that want to use Keycloak to secure themselves and provide a single sign-on solution. Clients can also be entities that just want to request identity information or an access token so that they can securely invoke other services on the network that are secured by Keycloak.
How to Create a Keycloak Data Source
- On the Sources page, click on the Create Source button and select the connector from the list.
- Select your dataset and click on Next to continue.DATADDO TIP
If you are not sure which dataset you need but know the metrics and attributes, use the Search by Name or Attribute function.
- From the drop-down menu, choose your account.Didn't find your account?
Click on Add new Account at the bottom of the drop-down and follow the on-screen prompts. You can also go to the Authorizers tab and click on Add New Service.
- Name your data source and select your metrics and attributes. Please keep in mind that metrics and attributes depend on the selected dataset.
- Configure your snapshotting preferences. Choose your sync frequency or the exact synchronization time under Show advanced settings.DATADDO TIP
If you need to load historical data, please refer to the Data Backfilling article.
- Preview your data by clicking on the Test Data button in the top right corner. You can adjust the date range for a more specific time frame.
- Click on Save and congratulations, your new data source is ready!
Data Preview Unavailable
If there is no data preview after clicking on Test Data, there might be a problem with your source configuration. The most common causes are:
- Date range: Try a smaller date range. You can load the rest of your data afterward through our manual data load function.
- Insufficient permissions: Please make sure your authorized account has at least admin-level permissions.
- Invalid metrics, attributes, or breakdowns: You may not have any data for the selected metrics, attributes, or breakdowns.
- Incompatible combination of metrics, attributes, or breakdowns: The combination you have selected cannot be queried together. Please refer to the service's documentation to view a full list of metrics that can be included in the same source.
Now that you have successfully created a data source, see how you can connect your data to a dashboarding app or a data storage.