{ "opencollection": "1.0.0", "info": { "name": "Auth0 Authentication actions rules API", "version": "1.0.0" }, "items": [ { "info": { "name": "rules", "type": "folder" }, "items": [ { "info": { "name": "Get Rules", "type": "http" }, "http": { "method": "GET", "url": "{auth0_domain}/rules", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page index of the results to return. First page is 0." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results per page." }, { "name": "include_totals", "value": "", "type": "query", "description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)." }, { "name": "enabled", "value": "", "type": "query", "description": "Optional filter on whether a rule is enabled (true) or disabled (false)." }, { "name": "fields", "value": "", "type": "query", "description": "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." }, { "name": "include_fields", "value": "", "type": "query", "description": "Whether specified fields are to be included (true) or excluded (false)." } ] }, "docs": "Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.\n" }, { "info": { "name": "Create a Rule", "type": "http" }, "http": { "method": "POST", "url": "{auth0_domain}/rules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new rule.\n\nNote: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.\n" }, { "info": { "name": "Get a Rule", "type": "http" }, "http": { "method": "GET", "url": "{auth0_domain}/rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the rule to retrieve." }, { "name": "fields", "value": "", "type": "query", "description": "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." }, { "name": "include_fields", "value": "", "type": "query", "description": "Whether specified fields are to be included (true) or excluded (false)." } ] }, "docs": "Retrieve rule details. Accepts a list of fields to include or exclude in the result.\n" }, { "info": { "name": "Update a Rule", "type": "http" }, "http": { "method": "PATCH", "url": "{auth0_domain}/rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the rule to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing rule.\n" }, { "info": { "name": "Delete a Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{auth0_domain}/rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the rule to delete." } ] }, "docs": "Delete a rule.\n" } ] } ], "bundled": true }