Method: Auth0::Api::V2::Users#users

Defined in:

lib/auth0/api/v2/users.rb

#users(options = {}) ⇒ json Also known as: get_users

Retrieves a list of Auth0 users.

Parameters:

• options (hash) (defaults to: {}) —

  The Hash options used to refine the User results.

  • :per_page [integer] The amount of entries per page. Default: 50. Max value: 100.

  • :page [integer] The page number. Zero based.

  • :include_totals [boolean] True if a query summary must be included in the result.

  • :sort [string] The field to use for sorting. 1 == ascending and -1 == descending.

  • :connection [string] Connection to filter results by.

  • :fields [string] A comma separated list of result fields.

  • :include_fields [boolean] True to include :fields, false to exclude.

  • :q [string] Query in Lucene query string syntax.

  • :search_engine [string] User search engine version.

    • Will default to v2 if no value is passed.

    • Default will change to v3 on 11/13/2018

    • See auth0.com/docs/users/search/v3#migrate-from-search-engine-v2-to-v3

Returns:

• (json) —

  Returns the list of existing users.

See Also:

• https://auth0.com/docs/api/management/v2#!/Users/get_users

# File 'lib/auth0/api/v2/users.rb', line 26

def users(options = {})
  request_params = {
    per_page:       options.fetch(:per_page, nil),
    page:           options.fetch(:page, nil),
    include_totals: options.fetch(:include_totals, nil),
    sort:           options.fetch(:sort, nil),
    connection:     options.fetch(:connection, nil),
    fields:         options.fetch(:fields, nil),
    include_fields: options.fetch(:include_fields, nil),
    q:              options.fetch(:q, nil),
    search_engine:  options.fetch(:search_engine, nil)
  }
  get(users_path, request_params)
end