Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal - Admin Management Admin External Login…

6 actions 6 updates phrasing extends openapi/strivacity-admin-external-login-provider-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/loginProviders'].get
$.paths['/admin/api/v1/admin/loginProviders'].post
$.paths['/admin/api/v1/admin/loginProviders/{id}'].get
$.paths['/admin/api/v1/admin/loginProviders/{id}'].put
$.paths['/admin/api/v1/admin/loginProviders/{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 Admin External Login…
  version: 1.0.0
extends: openapi/strivacity-admin-external-login-provider-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/loginProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin external login providers
      effect: read
      questions:
      - Which external identity providers can admins sign in with?
      - Can I search admin login providers by name?
      instructions:
      - text: List admin external login providers.
      - text: Find admin external login providers named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an admin external login provider
      effect: write
      questions:
      - How do I let administrators sign in through our corporate IdP?
      - Can admin console login use an external identity provider?
      instructions:
      - text: Create an admin external login provider.
      - text: Set up a new external IdP for admin console sign-in.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin external login provider
      effect: read
      questions:
      - How is a specific admin sign-in provider configured?
      - Can I view one admin external login provider?
      instructions:
      - text: Get admin external login provider {id}.
        slots:
          id: path.id
      - text: Show the configuration of admin sign-in provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an admin external login provider
      effect: write
      questions:
      - How do I change settings of the IdP my admins log in with?
      - Can I edit an existing admin external login provider?
      instructions:
      - text: Update admin external login provider {id}.
        slots:
          id: path.id
      - text: Change the settings of admin sign-in provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin external login provider
      effect: destructive
      questions:
      - How do I stop admins from logging in via an external IdP?
      - Can an admin external login provider be removed?
      instructions:
      - text: Delete admin external login provider {id}.
        slots:
          id: path.id
      - text: Remove admin sign-in provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'