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 OpenFGA Relationship Tuples API
version: 1.0.0
extends: openapi/auth0-relationship-tuples-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: 3
- target: $.paths['/stores/{store_id}/changes'].get
update:
x-apievangelist-phrasing:
intent: List relationship tuple changes in a store
effect: read
questions:
- What relationship tuples were added or deleted in my FGA store recently?
- Can I see only tuple changes for one object type since a given time?
instructions:
- text: List tuple changes in store {store_id}.
slots:
store_id: path.store_id
- text: List changes for type {type} in store {store_id} since {start_time}.
slots:
type: query.type
store_id: path.store_id
start_time: query.start_time
method: generated
generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/read'].post
update:
x-apievangelist-phrasing:
intent: Query stored relationship tuples
effect: read
questions:
- Which relationship tuples are stored for a given object or user?
- Does reading tuples follow userset rewrite rules?
instructions:
- text: Read the tuples in store {store_id} matching {tuple_key}.
slots:
store_id: path.store_id
tuple_key: requestBody.tuple_key
- text: Fetch all stored relationship tuples from store {store_id}.
slots:
store_id: path.store_id
method: generated
generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/write'].post
update:
x-apievangelist-phrasing:
intent: Add or delete relationship tuples
effect: write
questions:
- How do I grant a user a relation on an object by writing a tuple?
- Can I add and remove tuples in the same transaction?
instructions:
- text: Write tuples {writes} to store {store_id}.
slots:
writes: requestBody.writes
store_id: path.store_id
- text: In store {store_id}, add {writes} and delete {deletes} in one transaction.
slots:
store_id: path.store_id
writes: requestBody.writes
deletes: requestBody.deletes
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.