Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Verify Factors API

3 actions 3 updates phrasing extends openapi/twilio-factors-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/Services/{ServiceSid}/Entities/{Identity}/Factors'].get
$.paths['/Services/{ServiceSid}/Entities/{Identity}/Factors'].post

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 Twilio Verify Factors API
  version: 1.0.0
extends: openapi/twilio-factors-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/Services/{ServiceSid}/Entities/{Identity}/Factors'].get
  update:
    x-apievangelist-phrasing:
      intent: List an end user's authentication factors
      effect: read
      questions:
      - Which TOTP or push factors has a user enrolled?
      - Does this entity already have an authenticator set up?
      instructions:
      - text: List the factors for entity {identity} in Verify service {service}.
        slots:
          identity: path.Identity
          service: path.ServiceSid
      - text: Show all authentication factors enrolled by user {identity} on service {service}.
        slots:
          identity: path.Identity
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/Entities/{Identity}/Factors'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a TOTP or push factor for a user
      effect: write
      questions:
      - How do I let a user set up an authenticator app for two-factor login?
      - Can I register a push authentication factor for an end user?
      instructions:
      - text: Create a {factor_type} factor named {name} for entity {identity} in service {service}.
        slots:
          factor_type: requestBody.FactorType
          name: requestBody.FriendlyName
          identity: path.Identity
          service: path.ServiceSid
      - text: Enroll a {factor_type} factor {name} for user {identity} on service {service} with {code_length}-digit codes.
        slots:
          factor_type: requestBody.FactorType
          name: requestBody.FriendlyName
          identity: path.Identity
          service: path.ServiceSid
          code_length: requestBody.Binding.CodeLength
      method: generated
      generated: '2026-09-26'