topic Get User group with member details through API in API / CLI Discussion

Get User group with member details through API

Satish — Fri, 29 Nov 2024 06:01:37 GMT

Hi Team,

Please help me to get all User group with member details through API query.

Regards,

Satish

Re: Get User group with member details through API

Amir_Senn — Mon, 02 Dec 2024 14:54:41 GMT

Have you tried the following API?

https://sc1.checkpoint.com/documents/latest/APIs/index.html#cli/show-user-group~v2%20

Re: Get User group with member details through API

PhoneBoy — Mon, 02 Dec 2024 15:01:17 GMT

That only shows the members of the group, not the details of each one.
Which I suspect is what the original poster wants.

You'd have to query show-users for each user returned by the above call.

Re: Get User group with member details through API

Satish — Tue, 03 Dec 2024 06:32:17 GMT

Hi Admin,

Yes, I am expecting an API call which will provide me the User group with it's member details.

Like "show-service-groups" which provides Service group details with member service name UID.

I used "show-users". Output is providing User name with Group details. Under "groups" details, member information is available.

So, shall I consider this output for all User groups & their respective members?

Is there any other way....

Regards,

Satish

Re: Get User group with member details through API

PhoneBoy — Tue, 03 Dec 2024 13:53:37 GMT

Not clear what “member details” you are looking for here.
The more precisely you can describe the expected output, the more likely we can provide a meaningful answer to your query.

Re: Get User group with member details through API

Satish — Wed, 04 Dec 2024 12:11:38 GMT

Dear Admin,

I am looking for a single API query which will give me all User group details with their member names.

For example, there are 10 User groups configured and user group "Group A" members are 5 users.

So I should get details like below in a single query.

"Group A"

members

user1
user2
user3
user4
user5

"Group B"

Members

user8
user9
user10

Regards,

Satish

Re: Get User group with member details through API

PhoneBoy — Wed, 04 Dec 2024 14:47:18 GMT

To do that, you need to call show-user-groups with dereference-group-members true and details-level full as parameters.
Whether that will work in a single API call depends on how many users/groups you actually have since the API imposes limits.