Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Account Invitation API

6 actions 6 updates phrasing extends openapi/strivacity-account-invitation-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/identityStores/{identityStoreName}/invite'].get

$.paths['/admin/api/v1/identityStores/{identityStoreName}/invite'].post

$.paths['/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}'].get

$.paths['/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}'].delete

$.paths['/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}/resend'].post

OpenAPI Overlay

# 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 Account Invitation API
  version: 1.0.0
extends: openapi/strivacity-account-invitation-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/identityStores/{identityStoreName}/invite'].get
  update:
    x-apievangelist-phrasing:
      intent: List account invitations
      effect: read
      questions:
      - Which customer invitations are still pending in an identity store?
      - Can I filter account invitations by email or organization?
      instructions:
      - text: List account invitations in identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: List invitations to {email} in {identityStoreName}.
        slots:
          email: query.email
          identityStoreName: path.identityStoreName
      - text: Show {identityStoreName} invitations with accepted status {accepted}.
        slots:
          identityStoreName: path.identityStoreName
          accepted: query.accepted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to create an account
      effect: write
      questions:
      - How do I invite someone by email to register a customer account?
      - What happens if I invite an email address that already has a pending invitation?
      - Can an invitation skip email verification?
      instructions:
      - text: Invite {email} to identity store {identityStoreName} via client {clientId}.
        slots:
          email: requestBody.email
          identityStoreName: path.identityStoreName
          clientId: requestBody.clientId
      - text: Invite {email} to {identityStoreName} with roles {roles} and groups {groups}.
        slots:
          email: requestBody.email
          identityStoreName: path.identityStoreName
          roles: requestBody.roles
          groups: requestBody.groups
      - text: Send an invitation to {email} in {identityStoreName} in language {language}.
        slots:
          email: requestBody.email
          identityStoreName: path.identityStoreName
          language: requestBody.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account invitation
      effect: read
      questions:
      - Has a specific customer invitation been accepted yet?
      - Can I look up one account invitation by ID?
      instructions:
      - text: Get invitation {invitationId} in identity store {identityStoreName}.
        slots:
          invitationId: path.invitationId
          identityStoreName: path.identityStoreName
      - text: Show the status of {identityStoreName} invitation {invitationId}.
        slots:
          invitationId: path.invitationId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an account invitation
      effect: destructive
      questions:
      - How do I cancel a customer invitation that was sent by mistake?
      - Can a revoked account invitation still be used?
      instructions:
      - text: Revoke invitation {invitationId} in identity store {identityStoreName}.
        slots:
          invitationId: path.invitationId
          identityStoreName: path.identityStoreName
      - text: Cancel {identityStoreName} account invitation {invitationId}.
        slots:
          invitationId: path.invitationId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend an account invitation
      effect: write
      questions:
      - Can I resend an account invitation that the customer never received?
      - Does resending an invitation extend how long it stays valid?
      instructions:
      - text: Resend invitation {invitationId} in identity store {identityStoreName}.
        slots:
          invitationId: path.invitationId
          identityStoreName: path.identityStoreName
      - text: Send {identityStoreName} invitation {invitationId} again.
        slots:
          invitationId: path.invitationId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'