search

TheJumpCloud / jcapi-python

21 stars 20 forks source link

How to format "filter" (fix or add documentation) #46

Open boyleconnor opened 4 years ago

boyleconnor commented 4 years ago

I'm trying to use the SystemusersApi.systemusers_list() method to get a list of all users in a system.

I have managed to use the filter parameter successfully, with a string like the following: system_users_api.systemusers_list(content_type='application/json', accept='application/json', filter='firstname:David'). This successfully produces the expected behavior of returning all users with the first name of David.

The issue is: I came up with that string value for the filter parameter purely by trial-and-error. Also, I can't get it to work filtering multiple fields. I've tried several JSON-based solutions and nothing seems to work. I've seen examples of what to put in the filter parameter in the general (non-Python specific) API documentation (see this ), but I can't draw a connection to the filter parameter in the Python API. The Python API documentation pretty consistently describes the filter parameter (unhelpfully) as simply a "A filter to apply to the query."

thinkterry commented 4 years ago

Hi, @cascadianblue. JumpCloud Support would be happy to assist you. Could you open a support ticket by emailing your message to support@jumpcloud.com? We look forward to working with you!

adamo57 commented 4 years ago

also having this issue. @thinkterry please advise on how to set this filter parameter without having to contact an email support.

dbolack commented 3 years ago

This has also been a problem I haven't been able to get solved.

dbolack commented 3 years ago

My Boss got annoyed enough to go diving through the API and found this works:

api_instance.groups_user_list(CONTENT_TYPE, ACCEPT, limit=10, filter=['name:eq:acme-admin'])

So it looks like the format is a string of :: as a list rather that a stringified list as the docs imply.