Strivacity · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/strivacity-admin-external-login-mapping-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 7

$.info
$.paths['/admin/api/v1/admin/loginProviders/{providerId}/availableNativeClaims'].get
$.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings'].get
$.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings'].post
$.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings/{id}'].get
$.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings/{id}'].put
$.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings/{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-mapping-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: 6
- target: $.paths['/admin/api/v1/admin/loginProviders/{providerId}/availableNativeClaims'].get
  update:
    x-apievangelist-phrasing:
      intent: List unmapped native claims for an admin provider
      effect: read
      questions:
      - Which native claims are still free to map from an admin external login provider?
      - Can I see unmapped native claims for an admin login provider?
      instructions:
      - text: List native claims not yet mapped for admin login provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Show available native claims for admin external login provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List claim mappings for an admin login provider
      effect: read
      questions:
      - How are claims from an admin external login provider mapped to native claims?
      - Can I page through an admin login provider's claim mappings?
      instructions:
      - text: List claim mappings for admin login provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Show admin external login provider {providerId} mappings, page {page}.
        slots:
          providerId: path.providerId
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a claim mapping for an admin login provider
      effect: write
      questions:
      - How do I map a claim from an admin identity provider to a native claim?
      - Can an admin login claim mapping use a regex on the source value?
      instructions:
      - text: Map {sourcePath} to native claim {nativeClaim} for admin login provider {providerId}.
        slots:
          sourcePath: requestBody.sourcePath
          nativeClaim: requestBody.nativeClaim
          providerId: path.providerId
      - text: Create an admin provider {providerId} mapping from {sourcePath} with regex {fieldValueRegex} to {nativeClaim}.
        slots:
          providerId: path.providerId
          sourcePath: requestBody.sourcePath
          fieldValueRegex: requestBody.fieldValueRegex
          nativeClaim: requestBody.nativeClaim
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a claim mapping for an admin login provider
      effect: read
      questions:
      - What source path does one admin login provider claim mapping read from?
      - Can I view a single claim mapping on an admin external login provider?
      instructions:
      - text: Get claim mapping {id} of admin login provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      - text: Show admin external login mapping {id} on provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a claim mapping for an admin login provider
      effect: write
      questions:
      - Can I disable one claim mapping on an admin login provider?
      - How do I change the source path of an admin provider's claim mapping?
      instructions:
      - text: Update admin provider {providerId} mapping {id} to read from {sourcePath}.
        slots:
          providerId: path.providerId
          id: path.id
          sourcePath: requestBody.sourcePath
      - text: Set enabled to {enabled} on admin login mapping {id} of provider {providerId}.
        slots:
          enabled: requestBody.enabled
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/loginProviders/{providerId}/mappings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a claim mapping for an admin login provider
      effect: destructive
      questions:
      - How do I remove a claim mapping from an admin external login provider?
      - Is a deleted admin login claim mapping recoverable?
      instructions:
      - text: Delete claim mapping {id} from admin login provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      - text: Remove admin provider {providerId}'s mapping {id}.
        slots:
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'