Keycloak
  • 1 minute to read
  • Print
  • Share
  • Dark
    Light

Keycloak

  • Print
  • Share
  • Dark
    Light

Keycloak is an open source identity and access management solution.


Parameters

  1. Keycloak domain (required) - The domain or IP address of the Keycloak admin.
  2. User Name and Password (required) - The credentials for a user account that has the Required Permissions to fetch assets.
  3. Realm name (optional, default: master) - The desired realm name to fetch users.
    • If not supplied, Axonius will connect to the master realm.
    • If supplied, Axonius will connect to the supplied realm only.
  4. Client ID (optional, default: admin-cli) - The client entity associated with Keycloak admin.
    • If not supplied, Axonius will use the admin-cli client ID.
    • If supplied, Axonius will use the supplied client ID.
  5. Verify SSL (required, default: False) - Verify the SSL certificate offered by the value supplied in Keycloak domain. For more details, see SSL Trust & CA Settings.
    • If enabled, the SSL certificate offered by the value supplied in Keycloak domain will be verified against the CA database inside of Axonius. If the SSL certificate can not be validated against the CA database inside of Axonius, the connection will fail with an error.
    • If disabled, the SSL certificate offered by the value supplied in Keycloak domain will not be verified against the CA database inside of Axonius.
  6. HTTPS Proxy (optional, default: empty) - A proxy to use when connecting to the value supplied in Keycloak domain.
    • If supplied, Axonius will utilize the proxy when connecting to the value supplied in Keycloak domain.
    • If not supplied, Axonius will connect directly to the value supplied in Keycloak domain.
  7. For details on the common adapter connection parameters and buttons, see Adding a New Adapter Connection.

image.png


APIs

Axonius uses the Keycloak Admin REST API.

Required Permissions

The value supplied in User Name must have read access to the realm that was supplied in Client ID or to master realm .

Version Matrix

This adapter has only been tested with the versions marked as supported, but may work with other versions. Please contact Axonius Support if you have a version that is not listed and it is not functioning as expected.

Version Supported Notes
Keycloak Version 9.0.3 Yes


Was this article helpful?