Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Risk Assessments API

5 actions 5 updates phrasing extends openapi/auth0-risk-assessments-api-openapi.yml
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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/risk-assessments/settings'].get
$.paths['/risk-assessments/settings'].patch
$.paths['/risk-assessments/settings/new-device'].get
$.paths['/risk-assessments/settings/new-device'].patch

OpenAPI Overlay

Raw ↑
# 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 Risk Assessments API
  version: 1.0.0
extends: openapi/auth0-risk-assessments-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: 4
- target: $.paths['/risk-assessments/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tenant's risk assessment settings
      effect: read
      questions:
      - Are risk assessments turned on for my tenant?
      - Where can I check the overall risk assessment configuration?
      instructions:
      - text: Show me the risk assessment settings.
      - text: Check whether risk assessments are enabled.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/risk-assessments/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn risk assessments on or off
      effect: write
      questions:
      - How do I enable risk assessments on logins?
      - Can I disable risk assessments for the whole tenant?
      instructions:
      - text: Set risk assessments enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Turn tenant risk assessments on by setting enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/risk-assessments/settings/new-device'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the new-device assessor settings
      effect: read
      questions:
      - How long does the new device assessor remember a user's device?
      - What are the current settings for detecting logins from new devices?
      instructions:
      - text: Show me the new device assessor settings.
      - text: Get how many days a device is remembered for new-device risk checks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/risk-assessments/settings/new-device'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set how long devices are remembered
      effect: write
      questions:
      - Can I change how many days a device counts as known before it's flagged as new?
      - How do I tune the new device assessor's memory window?
      instructions:
      - text: Remember devices for {remember_for} days in the new device assessor.
        slots:
          remember_for: requestBody.remember_for
      - text: Set the new-device remember window to {remember_for}.
        slots:
          remember_for: requestBody.remember_for
      method: generated
      generated: '2026-10-01'