Keycloak
  • 3 Minutes to read
  • Dark
    Light

Keycloak

  • Dark
    Light

Overview

About

Keycloak is an open source software product to allow single sign-on with Identity and Access Management aimed at modern applications and services.

Available Datasets & Metrics

Currently, these datasets and endpoints are available in Dataddo:

Authorization

In order to obtain access to the API, you will need to provide your server, realm name, client ID, and client secret.

Client Secret

You can't get client_secret for public clients. Your client should have 'access_type` = 'confidential'

  1. Go to CLIENTS section of your realm admin panel (://:/auth/admin/master/console/#/realms//clients/)
  2. Change Access Type to confidential
  3. Press 'SAVE'
  4. Go to the "Credentials" tab
  5. Make sure that 'Client Authenticator' = 'Client Id and Secret'
  6. Here's your client secret.

More informaiton about authorization 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

  1. Sign in to your Dataddo account and click on Sources at the top of the page.

  2. Click on Create Source in the top right corner.

  3. Select the connector from the list of sources. You can type the name of the connector into the search bar to find it faster.
    Data sources - choose connectors

  4. First, select the required Dataset and click on Next.
    NOTE: If you are not sure which Dataset you need, but you know which Metrics and Attributes you are looking for, you can use the Search by Name or Attribute function or you can browse through all the possible Attributes and Metrics for each Dataset by clicking on the specific Dataset.
    Keycloak - datasets

  5. From the drop-down menu, choose your Account connected to Dataddo. Click on Next to continue with the setup.

    1. Didn't find your account?
      If you want to connect a new account that is not on the list, click on Add New Account at the bottom of the drop-down. You will be redirected to the authorization/sign-in page to confirm the right account. Once you confirm, you will be redirected back to the Dataddo app.

    2. Authorize your account
      If you have not authorized your Account with Dataddo, click on Add New Account and you will be redirected to the authorization/sign-in page.
      Keycloak - authorization

    3. After you log in and give Dataddo the necessary permissions to access your data, you will be redirected back to the connector.

  6. Choose a Name for your Data Source, and select the Metrics and Attributes. To continue to the next page, click Next.
    NOTE: The Metrics and Attributes depend on the Dataset you selected in the previous step. If you need different Metrics and Attributes, go back two steps and change the Dataset.
    Keycloak - metrics

  7. Configure your snapshotting preferences by choosing your Sync frequency. Under Advanced settings you can selec the exactTime, of synchronization. Confirm your setup by clicking on Next.
    *If the Data range is available to select, you can load historical data. Read more in our guide.

  8. Before saving the source, you can see a preview of your data by clicking on the Preview button. you can adjust the date range to a more specific view.
    You can see the full list of the metrics you selected by clicking on Show all Metrics and attributes, in the left navigation.
    Data source - create - preview

  9. Click on Save and your new Data Source is ready.

Congratulations, your new Data Source is ready!

Broken View / Error Message

If you cannot see a preview of your data, go back a few steps and check your setup. The most common causes are:
* Date range - we recommend a smaller date range. If you need to load historical data, check our guide.
* Invalid metrics, attributes or breakdowns, or their combination - you may not have any values for them.
Data source -create- error


Need assistance?

Feel free to contact us and we will help you with the setup. To speed the process of resolving your issue, make sure you provide us with sufficient information.


Was this article helpful?

What's Next