Skip to main content Link Menu Expand (external link) Document Search Copy Copied

auth0 users search

Search for users. To create one, run: auth0 users create.

Usage

auth0 users search [flags]

Examples

  auth0 users search
  auth0 users search --query user_id:"<user-id>"
  auth0 users search --query name:"Bob" --sort "name:1"
  auth0 users search -q name:"Bob" -s "name:1" --number 200
  auth0 users search -q name:"Bob" -s "name:1" -n 200 --json
  auth0 users search -q name:"Bob" -s "name:1" -n 200 --csv

Flags

      --csv                                                                     Output in csv format.
      --json                                                                    Output in json format.
  -n, --number int                                                              Number of users, that match the search criteria, to retrieve. Minimum 1, maximum 1000. If limit is hit, refine the search query. (default 100)
  -q, --query email:"user123@*.com" OR (user_id:"user-id-123" AND name:"Bob")   Search query in Lucene query syntax.
                                                                                
                                                                                For example: email:"user123@*.com" OR (user_id:"user-id-123" AND name:"Bob")
                                                                                
                                                                                 For more info: https://auth0.com/docs/users/user-search/user-search-query-syntax.
  -s, --sort string                                                             Field to sort by. Use 'field:order' where 'order' is '1' for ascending and '-1' for descending. e.g. 'created_at:1'.

Inherited Flags

      --debug           Enable debug mode.
      --no-color        Disable colors.
      --no-input        Disable interactivity.
      --tenant string   Specific tenant to use.