Auth0 API | Rules › Get Rules

Rules

rules

Methods

Create A Rule ->

post/rules

Note: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.

Delete A Rule ->

delete/rules/{id}

Delete a rule.

Get Rules -> RulesPageNumberPage<

Rule

get/rules

Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

enabled: boolean

Optional

Optional filter on whether a rule is enabled (true) or disabled (false).

fields: string

Optional

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields: boolean

Optional

Whether specified fields are to be included (true) or excluded (false).

include_totals: boolean

Optional

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

page: number

Optional

(minimum: 0)

Page index of the results to return. First page is 0.

per_page: number

Optional

(maximum: 100, minimum: 0)

Number of results per page.

Response fields

UnionMember0 = Array<

Rule

UnionMember1 = { limit, rules, start, 1 more... }

Request example

curl https://login0.local.dev.auth0.com/api/v2/rules \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

[
  {
    "id": "id",
    "enabled": true,
    "name": "name",
    "order": 0,
    "script": "script",
    "stage": "stage"
  }
]

Get A Rule ->

Rule

get/rules/{id}

Retrieve rule details. Accepts a list of fields to include or exclude in the result.

Update A Rule ->

Rule

patch/rules/{id}

Update an existing rule.

Domain types

Rule = { id, enabled, name, 3 more... }