Generated by API Evangelist
Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Auth0 Management Rules API
version: 1.0.0
extends: openapi/auth0-rules-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/rules'].get
update:
x-apievangelist-phrasing:
intent: List rules
effect: read
questions:
- Which rules run during login in my tenant?
- Can I list only enabled rules?
instructions:
- text: List my rules.
- text: List rules where enabled is {enabled}.
slots:
enabled: query.enabled
method: generated
generated: '2026-10-01'
- target: $.paths['/rules'].post
update:
x-apievangelist-phrasing:
intent: Create a rule
effect: write
questions:
- How do I add a rule script that runs on login?
- Can I set the execution order when creating a rule?
instructions:
- text: Create rule {name} with script {script}.
slots:
name: requestBody.name
script: requestBody.script
- text: Create rule {name} running {script} at order {order}.
slots:
name: requestBody.name
script: requestBody.script
order: requestBody.order
method: generated
generated: '2026-10-01'
- target: $.paths['/rules/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a rule by ID
effect: read
questions:
- Can I read the script of a specific rule?
- What order and enabled state does one rule have?
instructions:
- text: Show rule {id}.
slots:
id: path.id
- text: Get the script of rule {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/rules/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a rule
effect: destructive
questions:
- How do I delete a rule?
- Can I remove a login rule I no longer need?
instructions:
- text: Delete rule {id}.
slots:
id: path.id
- text: Remove rule {id} from the tenant.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/rules/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a rule
effect: write
questions:
- Can I disable a rule without deleting it?
- How do I change a rule's script or position in the order?
instructions:
- text: Set enabled to {enabled} on rule {id}.
slots:
enabled: requestBody.enabled
id: path.id
- text: Replace the script of rule {id} with {script}.
slots:
id: path.id
script: requestBody.script
- text: Move rule {id} to order {order}.
slots:
id: path.id
order: requestBody.order
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.