Uploaded image for project: 'Managed Service - API'
  1. Managed Service - API
  2. MGDAPI-6352

Keycloak client investigation - investigate CRUD on clients, realms and users

XMLWordPrintable

    • Icon: Spike Spike
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • None
    • None
    • RHOAM Sprint 59

      WHY
      With the move to RHBK we want to provide our customers with least impactful way when migrating to RHBK from RHSSO

      WHAT
      Currently, RHSSO supports following CRDs:

      • User
      • Client
      • Realm

      With the move to RHBK these CRDs are no longer supported.
      The alternative to creating assets in keycloak via CRs is to create them via API calls.
      This will be achieved via Keycloak Client repository (https://github.com/integr8ly/keycloak-client).
      The ask in this Jira is to give the API calls a try and create, update and delete the following:

      • User
      • Client
      • Realm

      Investigate the settings required like:

      • When client is created, is it possible to disable the ISS option via API call ( more info in the epic brief: https://docs.google.com/document/d/1heIsXF-CQqXcp1nc6cKkOpiOapOjLZ9dT-9aVRVWWyU/edit)
      • Is it possible to create realm and update or delete it to match closely what RHOAM realms have?
      • Is it possible to create user and update or delete it via API calls to match closely what RHOAM users CRs have?
      • Is it possible to create client and update or delete it via API calls to match closely what RHOAM client CRs have?
      • What kind of refactor are we looking at when it comes to the keycloak repository to make this work?

      HOW

      • Install RHOAM as it is with RHSSO and create testing IDP and log in to 3scale with at least one user
      • Install RHOAM with RHBK (how to described here: https://docs.google.com/document/d/159zSedYwbjhclToiBKwaWEvqQJJiwGjGV85fxVEmw_E/edit) and try reproducing the configuration via API calls
      • Familiarize yourself with keycloak client repository to have a good understanding on how the users, realms and clients are created, updated or deleted.
      • Come up with proposal on what would need to be refactored in the keycloak client repository to make it work

      TESTS

      • Test CRUD calls on clients, realms and users

      DONE

      • all api calls necessary have been tested and documented
      • assignee of this Jira has a good understanding of how keycloak client works and how keycloak assets are created via the repo
      • proposal on refactor of keycloak client is documented and follow up Jira requesting the refactor is created

              aucunnin@redhat.com Austin Cunningham
              mstoklus_rhmi Michal Stokluska
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: