Method: Auth0::Api::V2::Rules#rules

Defined in:
lib/auth0/api/v2/rules.rb

#rules(enabled: nil, fields: nil, include_fields: nil, stage: nil, page: nil, per_page: nil) ⇒ json Also known as: get_rules

Retrieves a list of all rules. Accepts a list of fields to include or exclude. The enabled parameter can be specified to get enabled or disabled rules. The rule’s stage of executing could be set to the following values login_success, login_failure or pre_authorize

Parameters:

  • enabled (boolean) (defaults to: nil) —

    If provided retrieves rules that match the value, otherwise all rules are retrieved.

  • fields (string) (defaults to: nil) —

    A comma separated list of fields to include or exclude from the result.

  • include_fields (boolean) (defaults to: nil) —

    True if the fields specified are to be included in the result, false otherwise.

  • stage (string) (defaults to: nil) —

    Retrieves rules that match the execution stage (defaults to login_success).

  • page (int) (defaults to: nil) —

    Page number to get, 0-based.

  • per_page (int) (defaults to: nil) —

    Results per page if also passing a page number.

Returns:

  • (json) —

    Returns the existing rules.

See Also:



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/auth0/api/v2/rules.rb', line 21

def rules(enabled: nil, fields: nil, include_fields: nil, stage: nil, page: nil, per_page: nil)
  request_params = {
    enabled:          enabled,
    fields:           fields,
    include_fields:   include_fields,
    stage:            stage,
    page:             page,
    per_page:         per_page
  }
  get(rules_path, request_params)
end