keycloak-admin 1.1.3 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be47369f8365b8b32ff4ca3b09ebad45f5037212eca3022524b10ba17b0f64d6
-  data.tar.gz: 36a340f437ecb97ce5c415e752d5e1159ebbc5911d454f643985de541c6deaf3
+  metadata.gz: dc70b33efe8f4293f7eb0f60eeb30f9468d7866a08e20180b6a3b66c35c96ea8
+  data.tar.gz: f9cfd0bec183db13053ecd034c4c0c180a8564c116fdb6ace4271a086622f18b
 SHA512:
-  metadata.gz: 6bd85e4709a0044168b7c3b3e9e2d89b1fab559070d4a318d65283db2046716439c4d1d0a534ba3cc9b1cbc89771626945877a76723bd03cc5f0e6dbebe6b266
-  data.tar.gz: e4b2286bac6d7e11192a1f3b6a569170849275bd3fa91aa104cdf521139a691396c8681a4152b5611e6a28e6c1457f60329b39ebca44cc4eb328f9ade9f7f605
+  metadata.gz: a3a4bf1e49ea91c845458186565f68636244e515a7ad78d12e69c50ad190de94fd38050a3222ed16eb33f0b5a13d5e1aa65e496ebb48fb732a5248ff6c227953
+  data.tar.gz: b60ee39f400e84c57f1627042abbb07b0ca820471d3fe53448c09a2ef8b4cc1acb193ea4f11d63d4b60941f0ee9496ecb6a5fc89bc6007fa1c1eca69a5b37925

data/.github/workflows/ci.yml

@@ -70,10 +70,7 @@ jobs:
 
     - uses: actions/checkout@v4
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/CHANGELOG.md

@@ -1,189 +1,201 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.1.3] - 2024-07-12
-
-* Client Authorization management support (thanks to @tillawy)
-* GitHub-actions setup to execute `rspec` (thanks to @tillawy)
-
-## [1.1.2] - 2024-05-22
-
-* Add group endpoints (get, children, delete), support for group attributes (thanks to @mkrawc)
-* GroupClient#save method now can update an existing group (thanks to @mkrawc)
-* RoleClient#save method now can update an existing role (thanks to @mkrawc)
-
-## [1.1.1] - 2024-01-21
-
-* Add/List realm-role/s to a group, Allow role-names with spaces, List groups assigned to role (thanks to @LiquidMagical)
-
-## [1.1.0] - 2023-10-03
-
-* Search for groups with parameters (thanks to @@tlloydthwaites)
-* Get client by ID, Find client by Client ID, Update Client (thanks to @gee-forr)
-
-## [1.0.24] - 2023-06-07
-
-* Revert the modifications on the feature 'Update a User' introduced in `1.0.22`. This implementation had breaking changes such as not being able to update several attributes (`first_name`, `email`, etc).
-
-## [1.0.23] - 2023-06-01
-
-* Be more permissive about the version of `rest-client` (`~> 2.0`) (thanks to @type-face)
-
-## [1.0.22] - 2023-05-29
-
-* Fetch user's all active sessions (thanks to @prsanjay)
-* Check whether a user is locked or not (thanks to @prsanjay)
-* Logout users from all the active sessions (thanks to @prsanjay)
-
-## [1.0.21] - 2023-02-03
-
-* List users who are a member of a group (thanks to @tlloydthwaites) 
-
-## [1.0.20] - 2022-12-26
-
-* Create subgroups (thanks to @neckhair)
-* Add subgroups to `GroupRepresentation` (thanks to @neckhair)
-* Expose `BaseRoleContainingResource.resource_id` (thanks to @neckhair)
-
-## [1.0.19] - 2022-12-03
-
-* Remove specific realm roles from user (thanks to @tlloydthwaites) 
-* Get role by name (thanks to @tlloydthwaites) 
-
-## [1.0.18] - 2022-11-24
-
-* List user realm-level role mappings (thanks to @Kazhuu) 
-
-## [1.0.17] - 2022-11-02
-
-* Delete `Client` 
-
-## [1.0.16] - 2022-10-15
-
-* Remove `rest-client` warning when adding a group (thanks to @tlloydthwaites)
-
-## [1.0.15] - 2022-05-23
-
-* Delete all "realm" roles mapped to a user
-
-## [1.0.14] - 2022-03-30
-
-* Update `Gemfile.lock` to avoid wrong CVE detections. The version of Rails should always be specified by the parent project. This change has no functional impact.
-
-## [1.0.13] - 2022-03-13
-
-* Add client role on users
-* List client roles
-
-## [1.0.7] - 2022-03-13
-
-* Allow to use multiple `KeycloakAdmin::Client` in the same environment 
-
-## [1.0.6] - 2022-03-13
-
-* When serializing an array to JSON, force the serialization to use `to_json` for each element. In several contexts (e.g. Rails), `to_json` is not used.
-
-## [1.0.5] - 2022-03-11
-
-* Create `Client`
-* Create `Identity Provider` (Breaking change: `IdentityProviderRepresentation.configuration` has been renamed to `IdentityProviderRepresentation.config`)
-* Add `Identity Provider Mapping`
-* Find service account for a `Client`
-
-## [1.0.1] - 2021-10-14
-
-* List all `Identity Providers`
-* Add Group on Users (thanks to @tomuench)
-* Remove Group from Users (thanks to @tomuench)
-
-## [1.0.0] - 2021-08-03
-
-* Add `totp` on Users
-* Add `required_actions` on Users
-
-## [0.7.9] - 2020-10-22
-
-* Extend `search` function to use complex queries (thanks to @hobbypunk90)
-
-## [0.7.8] - 2020-10-15
-
-* Bug: `rest_client_options` default value does not match the documentation (was `nil` by default, should be `{}`)
-* Update documentation about client setup (based on Keycloak 11)
-
-## [0.7.7] - 2020-07-10
-
-* Fix: `Replace request method shorthand with .execute for proper RestClient option support` (thanks to @RomanHargrave)
-* When sending action emails, add lifespan as an optional parameter (thanks to @hobbypunk90)
-
-## [0.7.6] - 2020-06-22
-
-Thanks to @hobbypunk90 
-* Support for action emails and send forgot passsword mail 
-
-## [0.7.5] - 2020-03-28
-
-Thanks to @RomanHargrave
-* Support for working with federated identity provider (broker) links
-
-## [0.7.4] - 2019-10-17
-
-* Support for Rails 6
-
-## [0.7.3] - 2019-07-11
-
-Thanks to @cederigo:
-* For a given user, get her list of groups
-
-## [0.7.2] - 2019-06-17
-
-Thanks to @vlad-ro:
-
-* Get list of client role mappings for a group
-* Save client role mappings for a user/group
-* Save realm-level role mappings for a user/group
-
-## [0.7.1] - 2019-06-11
-
-Thanks to @vlad-ro:
-
-* List users
-* List clients
-* List groups, create/save a group
-* List roles, save a role
-* List realms, save/update/delete a realm
-* Get list of client role mappings for a user
-* Support passing rest client options for user save and search
-* Support using gem without ActiveSupport
-
-## [0.7.0] - 2019-06-06
-
-Thanks to @vlad-ro:
-
-* Support passing rest client options
-* More documentation
-* More tests
-* Better handling of timeouts
-
-## [0.6.5] - 2019-05-14
-
-* Get user
-
-## [0.6.2] - 2019-05-14
-
-* Update users
-
-## [0.6] - 2019-03-06
-
-* Save a locale when creating a new user
-
-## [0.5] - 2018-01-26
-
-* Client to access Custom REST API configurable-token
-
-## [0.3] - 2018-01-19
-
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.5] - 2026-01-05
+
+* [Feature] Added the ability to list credentials for a given user.
+* [Fix] Implemented safe parsing for nested JSON elements within `CredentialRepresentation` (handling both `credentialData` and `secretData` fields). Please refer to [the official documentation](https://www.keycloak.org/docs-api/latest/rest-api/index.html#CredentialRepresentation).
+* [Breaking] Renamed `CredentialRepresentation` attribute `created_date` $\rightarrow$ `createdDate` to align with the Keycloak Admin API.
+
+## [1.1.4] - 2025-11-08
+
+* Add remove_realm_level_role_name! action on a GroupClient (thanks to @mkrawc)
+* Dependencies: Update Gemfile.lock to bump byebug → 12.0.0, rspec → 3.13.2, and related dependencies
+* Bug: The 'remove' operation of the 'RoleMapperClient' does not take the global rest options into account
+
+## [1.1.3] - 2024-07-12
+
+* Client Authorization management support (thanks to @tillawy)
+* GitHub-actions setup to execute `rspec` (thanks to @tillawy)
+
+## [1.1.2] - 2024-05-22
+
+* Add group endpoints (get, children, delete), support for group attributes (thanks to @mkrawc)
+* GroupClient#save method now can update an existing group (thanks to @mkrawc)
+* RoleClient#save method now can update an existing role (thanks to @mkrawc)
+
+## [1.1.1] - 2024-01-21
+
+* Add/List realm-role/s to a group, Allow role-names with spaces, List groups assigned to role (thanks to @LiquidMagical)
+
+## [1.1.0] - 2023-10-03
+
+* Search for groups with parameters (thanks to @@tlloydthwaites)
+* Get client by ID, Find client by Client ID, Update Client (thanks to @gee-forr)
+
+## [1.0.24] - 2023-06-07
+
+* Revert the modifications on the feature 'Update a User' introduced in `1.0.22`. This implementation had breaking changes such as not being able to update several attributes (`first_name`, `email`, etc).
+
+## [1.0.23] - 2023-06-01
+
+* Be more permissive about the version of `rest-client` (`~> 2.0`) (thanks to @type-face)
+
+## [1.0.22] - 2023-05-29
+
+* Fetch user's all active sessions (thanks to @prsanjay)
+* Check whether a user is locked or not (thanks to @prsanjay)
+* Logout users from all the active sessions (thanks to @prsanjay)
+
+## [1.0.21] - 2023-02-03
+
+* List users who are a member of a group (thanks to @tlloydthwaites) 
+
+## [1.0.20] - 2022-12-26
+
+* Create subgroups (thanks to @neckhair)
+* Add subgroups to `GroupRepresentation` (thanks to @neckhair)
+* Expose `BaseRoleContainingResource.resource_id` (thanks to @neckhair)
+
+## [1.0.19] - 2022-12-03
+
+* Remove specific realm roles from user (thanks to @tlloydthwaites) 
+* Get role by name (thanks to @tlloydthwaites) 
+
+## [1.0.18] - 2022-11-24
+
+* List user realm-level role mappings (thanks to @Kazhuu) 
+
+## [1.0.17] - 2022-11-02
+
+* Delete `Client` 
+
+## [1.0.16] - 2022-10-15
+
+* Remove `rest-client` warning when adding a group (thanks to @tlloydthwaites)
+
+## [1.0.15] - 2022-05-23
+
+* Delete all "realm" roles mapped to a user
+
+## [1.0.14] - 2022-03-30
+
+* Update `Gemfile.lock` to avoid wrong CVE detections. The version of Rails should always be specified by the parent project. This change has no functional impact.
+
+## [1.0.13] - 2022-03-13
+
+* Add client role on users
+* List client roles
+
+## [1.0.7] - 2022-03-13
+
+* Allow to use multiple `KeycloakAdmin::Client` in the same environment 
+
+## [1.0.6] - 2022-03-13
+
+* When serializing an array to JSON, force the serialization to use `to_json` for each element. In several contexts (e.g. Rails), `to_json` is not used.
+
+## [1.0.5] - 2022-03-11
+
+* Create `Client`
+* Create `Identity Provider` (Breaking change: `IdentityProviderRepresentation.configuration` has been renamed to `IdentityProviderRepresentation.config`)
+* Add `Identity Provider Mapping`
+* Find service account for a `Client`
+
+## [1.0.1] - 2021-10-14
+
+* List all `Identity Providers`
+* Add Group on Users (thanks to @tomuench)
+* Remove Group from Users (thanks to @tomuench)
+
+## [1.0.0] - 2021-08-03
+
+* Add `totp` on Users
+* Add `required_actions` on Users
+
+## [0.7.9] - 2020-10-22
+
+* Extend `search` function to use complex queries (thanks to @hobbypunk90)
+
+## [0.7.8] - 2020-10-15
+
+* Bug: `rest_client_options` default value does not match the documentation (was `nil` by default, should be `{}`)
+* Update documentation about client setup (based on Keycloak 11)
+
+## [0.7.7] - 2020-07-10
+
+* Fix: `Replace request method shorthand with .execute for proper RestClient option support` (thanks to @RomanHargrave)
+* When sending action emails, add lifespan as an optional parameter (thanks to @hobbypunk90)
+
+## [0.7.6] - 2020-06-22
+
+Thanks to @hobbypunk90 
+* Support for action emails and send forgot passsword mail 
+
+## [0.7.5] - 2020-03-28
+
+Thanks to @RomanHargrave
+* Support for working with federated identity provider (broker) links
+
+## [0.7.4] - 2019-10-17
+
+* Support for Rails 6
+
+## [0.7.3] - 2019-07-11
+
+Thanks to @cederigo:
+* For a given user, get her list of groups
+
+## [0.7.2] - 2019-06-17
+
+Thanks to @vlad-ro:
+
+* Get list of client role mappings for a group
+* Save client role mappings for a user/group
+* Save realm-level role mappings for a user/group
+
+## [0.7.1] - 2019-06-11
+
+Thanks to @vlad-ro:
+
+* List users
+* List clients
+* List groups, create/save a group
+* List roles, save a role
+* List realms, save/update/delete a realm
+* Get list of client role mappings for a user
+* Support passing rest client options for user save and search
+* Support using gem without ActiveSupport
+
+## [0.7.0] - 2019-06-06
+
+Thanks to @vlad-ro:
+
+* Support passing rest client options
+* More documentation
+* More tests
+* Better handling of timeouts
+
+## [0.6.5] - 2019-05-14
+
+* Get user
+
+## [0.6.2] - 2019-05-14
+
+* Update users
+
+## [0.6] - 2019-03-06
+
+* Save a locale when creating a new user
+
+## [0.5] - 2018-01-26
+
+* Client to access Custom REST API configurable-token
+
+## [0.3] - 2018-01-19
+
 * Support of impersonation

data/Gemfile.lock

@@ -1,49 +1,51 @@
-PATH
-  remote: .
-  specs:
-    keycloak-admin (1.1.3)
-      http-cookie (~> 1.0, >= 1.0.3)
-      rest-client (~> 2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.1.3)
-    diff-lcs (1.5.1)
-    domain_name (0.6.20240107)
-    http-accept (1.7.0)
-    http-cookie (1.0.6)
-      domain_name (~> 0.5)
-    mime-types (3.5.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2024.0702)
-    netrc (0.11.0)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.3)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.7)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug (= 11.1.3)
-  keycloak-admin!
-  rspec (= 3.12.0)
-
-BUNDLED WITH
-   2.1.4
+PATH
+  remote: .
+  specs:
+    keycloak-admin (1.1.5)
+      http-cookie (~> 1.0, >= 1.0.3)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (12.0.0)
+    diff-lcs (1.6.2)
+    domain_name (0.6.20240107)
+    http-accept (1.7.0)
+    http-cookie (1.1.0)
+      domain_name (~> 0.5)
+    logger (1.7.0)
+    mime-types (3.7.0)
+      logger
+      mime-types-data (~> 3.2025, >= 3.2025.0507)
+    mime-types-data (3.2025.0924)
+    netrc (0.11.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (= 12.0.0)
+  keycloak-admin!
+  rspec (= 3.13.2)
+
+BUNDLED WITH
+   2.1.4