keycloak-admin 1.0.20 → 1.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e12b29d601e1a543c15d2d23820a1834088d4ab03fdde20ab81905ee0236309
-  data.tar.gz: 1d42e0333e35bf0c6faca2a1439533f2a35d5e85a0494b2fa0901d98b37ae99e
+  metadata.gz: 1a01d12df8eb75fcedbf128aacae50192983a47cb4cfac6c52b1dff4d999aa08
+  data.tar.gz: dae8911b975b7aea1989fc8df565047c144da55868569da02039c53fbc8d6963
 SHA512:
-  metadata.gz: 74e45f56d4ec1adca533d8c41fc9ae519a359a63c3632560c17fb927425b5e0f1e22519b6d8c99894b034acdd8c3b7a1229430a95a00e42fa024376b72bd8298
-  data.tar.gz: 662228969795e4fa165be24480714e662ac4e178c5ad1e3eaae14be90ffd245796db80bd0bedb02761e8d228a7b023dd426b52884029de449ebf2f8a02e7a8d9
+  metadata.gz: 8f44444327adcb4622856a7397401b5eaeaa10ad55943cce4606f4539340795a2e444f48613c35cdedb41c34431516b9137fec07f163d51c5e7c691ce3a7db17
+  data.tar.gz: 2210584caebc4c01e67a7da99740910755759a1edb22fb5c48002c0e51eb3d672460a74723db38bdc0bc639c2effd1cc42e4a8d30b79e185ce0d31a3a6c8ea72

data/CHANGELOG.md

@@ -5,6 +5,10 @@ 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.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)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (1.0.20)
+    keycloak-admin (1.0.21)
       http-cookie (~> 1.0, >= 1.0.3)
       rest-client (~> 2.1)
 

data/README.md

@@ -12,7 +12,7 @@ This gem *does not* require Rails.
 For example, using `bundle`, add this line to your Gemfile.
 
 ```ruby
-gem "keycloak-admin", "1.0.20"
+gem "keycloak-admin", "1.0.21"
 ```
 
 ## Login
@@ -119,6 +119,7 @@ All options have a default value. However, all of them can be changed in your in
 * Get list of roles, save a role
 * Get list of realms, save/update/delete a realm
 * Get list of client role mappings for a user/group
+* Get list of members of a group
 * Save client role mappings for a user/group
 * Save realm-level role mappings for a user/group
 * Add a Group on a User
@@ -320,6 +321,20 @@ group_name = "test"
 sub_group_id = KeycloakAdmin.realm("a_realm").groups.create_subgroup!(parent_id, group_name)
 ```
 
+### Get list of members of a group
+
+Returns an array of `KeycloakAdmin::UserRepresentation`.
+
+```ruby
+KeycloakAdmin.realm("a_realm").group("group_id").members
+```
+
+You can specify paging with `first` and `max`:
+
+```ruby
+KeycloakAdmin.realm("a_realm").group("group_id").members(first:0, max:100)
+```
+
 ### Get list of roles in a realm
 
 Returns an array of `KeycloakAdmin::RoleRepresentation`.

data/lib/keycloak-admin/client/group_client.rb

@@ -35,6 +35,19 @@ module KeycloakAdmin
       end
       created_id(response)
     end
+    
+    def members(group_id, first=0, max=100)
+      url = "#{groups_url(group_id)}/members"
+      query = {first: first.try(:to_i), max: max.try(:to_i)}.compact
+      unless query.empty?
+        query_string = query.to_a.map { |e| "#{e[0]}=#{e[1]}" }.join("&")
+        url = "#{url}?#{query_string}"
+      end
+      response = execute_http do
+        RestClient::Resource.new(url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |user_as_hash| UserRepresentation.from_hash(user_as_hash) }
+    end
 
     def groups_url(id=nil)
       if id

data/lib/keycloak-admin/resource/group_resource.rb

@@ -3,5 +3,9 @@ module KeycloakAdmin
     def resources_name
       "groups"
     end
+    
+    def members(first:0, max:100)
+      @realm_client.groups.members(@resource_id, first, max)
+    end
   end
 end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "1.0.20"
+  VERSION = "1.0.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 1.0.20
+  version: 1.0.21
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie