Get Users

Maximum number of results to return (default 50, maximum 500)

Field to sort by. Use [field name] for ascending and -[field name] for descending order. You can , seperate for multiple sort orders.

Filter conditions for searching users, formatted like ?filter=name=Bill. The filters should be ; separated, as shown below. Supported fields are "role", "name", "phone", "email", "userId", "groups", "applicationRoles". All filter conditions are "starts with". NOTE: When filtering on created and modified, all timestamps are in UTC. You need to encode reserved url characters if they are part of the data you are filtering. Example, * ' ( ) : @ & = + $ , / ? % # [ ] You need to double encode ; as %253B if it is a part of the data you are filtering.

Examples:

• filter=email=john@doe.com will fetch all users starting with email "john@doe.com"
• filter=filter={"name":{"$eq":"john@doe.com"}} will fetch all users that exactly match "john@doe.com"
• filter=role=Admin;created>2019-06-11T21:50:57.067Z will fetch all user with role starting with "Admin" and created after "2019-06-11T21:50:57.067Z" (UTC)
• filter=modified=2019-06-11T21:50:57.067Z will fetch users modified at exactly "2019-06-11T21:50:57.067Z" (UTC)
• filter=created>2019-06-11T00:00:00.000Z;created<2019-06-20T00:00:00.000Z will fetch users created between "2019-06-11T00:00:00.000Z" (UTC) and "2019-06-20T00:00:00.000Z" (UTC)

Supported operators (as specified in this library api-query-params):

• key=val type=public
• key>val count>5
• key>=val rating>=9.5
• key<val createdAt<2016-01-01
• key<=val score<=-5
• key!=val status!=success
• key=val1,val2 country=GB,US
• key!=val1,val2 lang!=fr,en
• key phone
• !key !email
• key=/value/<opts> email=/@gmail\.com$/i
• key!=/value/<opts> phone!=/^06/

Note: multiple forward slashes (/) are interpreted as a regex. To use a string comparison wrap your parameter with string(). Ex. email=string(/@gmail.com$/i).

Whether to allow show all users or all non service users. Note - The value should be passed as true/false Examples:

• showServiceUsers=true will show all the users in the system
• showServiceUsers=false will show all the non service users
• If the argument is not passed, by default all non service users will be displayed.