Is there a way to retrieve the number of members in a group using the Keycloak API?

Question

I am using Keycloak API and I have a use case where I need to get the number of members in a group, before fetching all users.

Unfortunately, both endpoints GET /{realm}/groups/{id}/members and GET /{realm}/groups/{id} do not return such information.

The API doc on https://www.keycloak.org/docs-api/5.0/rest-api/index.html does not seem to indicate how we can get the count.

So, how we can get this information using the Keycloak API ?

dreamcrash · Accepted Answer · 2021-03-07T16:47:38.893

4

Unfortunately, one does not have an endpoint like GET /{realm}/groups/{id}/members/count like one has for the number of groups (i.e., GET /{realm}/groups/count).

What you would need to do, is to define max query parameter to -1 so that you are sure to get all the members using the endpoint GET /{realm}/groups/{id}/members and then just count the number of members on the json response. Of course, this is a sub-optimal approach, but the only one using the API as it is.

I have provided a complete script that automatizes this processes in the following repo.

edited Mar 07 '21 at 16:47

answered Oct 07 '20 at 15:43

dreamcrash

47,137
25
94
117

Can we get the group members by specifying group name and not the id? – Soumee Giri Aug 04 '23 at 11:38
@SoumeeGiri No, As far as I can see on the Keycloak Admin API documentation. – dreamcrash Aug 04 '23 at 12:20

score 1 · Answer 2 · edited Dec 31 '22 at 16:17

1

As mentioned by @dreamcrash, you need to count that from the response of GET /{realm}/groups/{id}/members.

I am using jq.. then my script is:

curl  .... ${url}/${realm}/groups/${id}/members | jq '. | length'

edited Dec 31 '22 at 16:17

dreamcrash

47,137
25
94
117

answered Oct 19 '22 at 22:47

Abdennour TOUMI

87,526
38
249
254

Is there a way to retrieve the number of members in a group using the Keycloak API?

2 Answers2