Strivacity · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/strivacity-social-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/social/{providerId}/availableNativeClaims'].get
$.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings'].get
$.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings'].post
$.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings/{id}'].get
$.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings/{id}'].put
$.paths['/admin/api/v1/loginProviders/social/{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 Social Login Claim Mapping API
  version: 1.0.0
extends: openapi/strivacity-social-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/social/{providerId}/availableNativeClaims'].get
  update:
    x-apievangelist-phrasing:
      intent: List native claims not yet mapped for a social login
      effect: read
      questions:
      - Which native claims are still free to map for a social login provider?
      - Why isn't the id claim offered when mapping social login claims?
      instructions:
      - text: List unassigned native claims for social login provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Show native claims I can still map on social provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a social login provider's claim mappings
      effect: read
      questions:
      - How are fields from a social login mapped into my native claims?
      - Can I page through all claim mappings for a social provider?
      instructions:
      - text: List the claim mappings for social login provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Show every mapping configured on social provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a social login field to a native claim
      effect: write
      questions:
      - How do I copy the email from a social login profile into a native claim?
      - Can I apply a regex to a social login field before mapping it?
      instructions:
      - text: Map source path {sourcePath} to native claim {nativeClaim} on social provider {providerId}.
        slots:
          sourcePath: requestBody.sourcePath
          nativeClaim: requestBody.nativeClaim
          providerId: path.providerId
      - text: Create a claim mapping on {providerId} from {sourcePath} to {nativeClaim} using regex {fieldValueRegex}.
        slots:
          providerId: path.providerId
          sourcePath: requestBody.sourcePath
          nativeClaim: requestBody.nativeClaim
          fieldValueRegex: requestBody.fieldValueRegex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one social login claim mapping
      effect: read
      questions:
      - How do I view a single claim mapping on a social provider?
      - What source path feeds a specific social login mapping?
      instructions:
      - text: Show claim mapping {id} on social login provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      - text: Get mapping {id} of social provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a social login claim mapping
      effect: write
      questions:
      - How do I change the source path of an existing social claim mapping?
      - Can I disable a social login mapping without deleting it?
      instructions:
      - text: Update mapping {id} on social provider {providerId} to read from {sourcePath}.
        slots:
          id: path.id
          providerId: path.providerId
          sourcePath: requestBody.sourcePath
      - text: Set enabled to {enabled} on existing claim mapping {id} for provider {providerId}.
        slots:
          enabled: requestBody.enabled
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/loginProviders/social/{providerId}/mappings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a social login claim mapping
      effect: destructive
      questions:
      - How do I remove a claim mapping from a social login provider?
      - Can I stop mapping a social profile field entirely?
      instructions:
      - text: Delete claim mapping {id} from social login provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      - text: Remove mapping {id} on social provider {providerId}.
        slots:
          id: path.id
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'