Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MyAccount Portal Authenticator management API

4 actions 4 updates phrasing extends openapi/strivacity-authenticator-management-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/myaccount/api/v1/authenticators'].post

$.paths['/myaccount/api/v1/authenticators/{authenticatorId}'].post

$.paths['/myaccount/api/v1/authenticators/{authenticatorId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MyAccount Portal Authenticator management API
  version: 1.0.0
extends: openapi/strivacity-authenticator-management-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['/myaccount/api/v1/authenticators'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll an authenticator on my account
      effect: write
      questions:
      - How can a signed-in user add a new authenticator to their own account?
      - Why does enrolling an authenticator need a second request with a verification code?
      instructions:
      - text: Enroll a {type} authenticator for {target} with methods {methods}.
        slots:
          type: requestBody.type
          target: requestBody.target
          methods: requestBody.methods
      - text: Confirm enrolling {target} as a {type} authenticator ({methods}) with code {challenge}.
        slots:
          target: requestBody.target
          type: requestBody.type
          methods: requestBody.methods
          challenge: header.X-Challenge
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/authenticators/{authenticatorId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an authenticator's methods
      effect: write
      questions:
      - Can I change which methods an existing authenticator uses, like SMS or voice?
      - Is it possible to edit an authenticator on my account without re-enrolling?
      instructions:
      - text: Update authenticator {authenticatorId} to use methods {methods}.
        slots:
          authenticatorId: path.authenticatorId
          methods: requestBody.methods
      - text: Switch my authenticator {authenticatorId} methods to {methods}.
        slots:
          authenticatorId: path.authenticatorId
          methods: requestBody.methods
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/authenticators/{authenticatorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an authenticator from my account
      effect: destructive
      questions:
      - How does a user remove an authenticator from their account?
      - Do I need a verification code to delete an authenticator?
      instructions:
      - text: Delete authenticator {authenticatorId} from my account.
        slots:
          authenticatorId: path.authenticatorId
      - text: Confirm removing authenticator {authenticatorId} with code {challenge}.
        slots:
          authenticatorId: path.authenticatorId
          challenge: header.X-Challenge
      method: generated
      generated: '2026-10-01'