Auth0 API | Rules › Get A Rule

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<

get/rules

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

Get A Rule ->

get/rules/{id}

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

Security

Example: Authorization: Bearer My Bearer Token

Parameters

id: string

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).

Response fields

Request example

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

200Example

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

Update A Rule ->

patch/rules/{id}

Update an existing rule.

Domain types

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