Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Enterprise Login Claim Mapping API

7 actions 7 updates phrasing extends openapi/strivacity-enterprise-login-claim-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/loginProviders/enterprise/{providerId}/availableNativeClaims'].get
$.paths['/admin/api/v1/loginProviders/enterprise/{providerId}/mappings'].get
$.paths['/admin/api/v1/loginProviders/enterprise/{providerId}/mappings'].post
$.paths['/admin/api/v1/loginProviders/enterprise/{providerId}/mappings/{id}'].get
$.paths['/admin/api/v1/loginProviders/enterprise/{providerId}/mappings/{id}'].put
$.paths['/admin/api/v1/loginProviders/enterprise/{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 Enterprise Login Claim Mapping API
  version: 1.0.0
extends: openapi/strivacity-enterprise-login-claim-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/loginProviders/enterprise/{providerId}/availableNativeClaims'].get
  update:
    x-apievangelist-phrasing:
      intent: List unmapped native claims for an enterprise provider
      effect: read
      questions:
      - Which native claims haven't been mapped yet for an enterprise login provider?
      - Can I list free native claims for an enterprise SSO connection?
      instructions:
      - text: List native claims not mapped for enterprise provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Show available native claims for enterprise login provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/enterprise/{providerId}/mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List claim mappings for an enterprise provider
      effect: read
      questions:
      - How are claims from an enterprise identity provider mapped into customer accounts?
      - Can I page through the claim mappings of an enterprise login provider?
      instructions:
      - text: List claim mappings for enterprise provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Show enterprise login provider {providerId} mappings, page {page}.
        slots:
          providerId: path.providerId
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/enterprise/{providerId}/mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a claim mapping for an enterprise provider
      effect: write
      questions:
      - How do I map an attribute from an enterprise SSO provider to a native claim?
      - Can an enterprise claim mapping filter the incoming value with a regex?
      instructions:
      - text: Map {sourcePath} to native claim {nativeClaim} for enterprise provider {providerId}.
        slots:
          sourcePath: requestBody.sourcePath
          nativeClaim: requestBody.nativeClaim
          providerId: path.providerId
      - text: Create an enterprise 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/loginProviders/enterprise/{providerId}/mappings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a claim mapping for an enterprise provider
      effect: read
      questions:
      - What does one enterprise login provider claim mapping look like?
      - Can I check which native claim an enterprise mapping feeds?
      instructions:
      - text: Get claim mapping {id} of enterprise provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      - text: Show enterprise login mapping {id} on provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/enterprise/{providerId}/mappings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a claim mapping for an enterprise provider
      effect: write
      questions:
      - Can I turn off a single enterprise login claim mapping?
      - How do I point an enterprise claim mapping at a different native claim?
      instructions:
      - text: Update enterprise provider {providerId} mapping {id} to target {nativeClaim}.
        slots:
          providerId: path.providerId
          id: path.id
          nativeClaim: requestBody.nativeClaim
      - text: Set enabled to {enabled} on enterprise 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/loginProviders/enterprise/{providerId}/mappings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a claim mapping for an enterprise provider
      effect: destructive
      questions:
      - How do I delete a claim mapping from an enterprise SSO provider?
      - Is removing an enterprise login claim mapping permanent?
      instructions:
      - text: Delete claim mapping {id} from enterprise provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      - text: Remove enterprise provider {providerId}'s mapping {id}.
        slots:
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'