Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal - Admin Management Custom Adaptive MFA API

6 actions 6 updates phrasing extends openapi/strivacity-custom-adaptive-mfa-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 6

$.info
$.paths['/admin/api/v1/admin/customMfas'].get
$.paths['/admin/api/v1/admin/customMfas'].post
$.paths['/admin/api/v1/admin/customMfas/{id}'].get
$.paths['/admin/api/v1/admin/customMfas/{id}'].put
$.paths['/admin/api/v1/admin/customMfas/{id}'].delete

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 Admin Portal - Admin Management Custom Adaptive MFA API
  version: 1.0.0
extends: openapi/strivacity-custom-adaptive-mfa-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: 5
- target: $.paths['/admin/api/v1/admin/customMfas'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom MFAs
      effect: read
      questions:
      - What custom MFA methods have been built for my instance?
      - Can I list the custom mfa definitions available to adaptive access policies?
      instructions:
      - text: List custom MFAs.
      - text: Show all custom MFA methods.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/customMfas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom MFA
      effect: write
      questions:
      - How do I add my own MFA method with custom code?
      - Can a custom MFA use npm package dependencies?
      instructions:
      - text: Create custom MFA {name} with methods {methods} and dependencies {packageDependencies}.
        slots:
          name: requestBody.name
          methods: requestBody.methods
          packageDependencies: requestBody.packageDependencies
      - text: Create custom MFA {name} with code {code}, methods {methods}, dependencies {packageDependencies}.
        slots:
          name: requestBody.name
          code: requestBody.code
          methods: requestBody.methods
          packageDependencies: requestBody.packageDependencies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/customMfas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom MFA
      effect: read
      questions:
      - Can I see the code and methods of one custom MFA?
      - What icon and dependencies does a specific custom MFA use?
      instructions:
      - text: Get custom MFA {id}.
        slots:
          id: path.id
      - text: Show the definition of custom MFA {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/customMfas/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom MFA
      effect: write
      questions:
      - How do I change the code of an existing custom MFA?
      - Can I update a custom MFA's icon URL?
      instructions:
      - text: Update custom MFA {id} with code {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Set the icon of custom MFA {id} to {iconUrl}.
        slots:
          id: path.id
          iconUrl: requestBody.iconUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/customMfas/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom MFA
      effect: destructive
      questions:
      - Why can't I delete a custom MFA that a policy still uses?
      - How do I remove a custom MFA?
      instructions:
      - text: Delete custom MFA {id}.
        slots:
          id: path.id
      - text: Remove the unused custom MFA {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'