# 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 Account Invitation API
  version: 1.0.0
extends: openapi/strivacity-admin-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/admin/identityStore/invite'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin account invitations
      effect: read
      questions:
      - Which administrator invitations are still waiting to be accepted?
      - Can I filter admin invitations by email address?
      instructions:
      - text: List admin account invitations.
      - text: List admin invitations sent to {email}.
        slots:
          email: query.email
      - text: Show admin invitations with accepted status {accepted}.
        slots:
          accepted: query.accepted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a new administrator
      effect: write
      questions:
      - How do I invite a new administrator to the admin console?
      - What happens if an admin invite already exists for that email?
      instructions:
      - text: Invite {email} as an administrator with roles {roles}.
        slots:
          email: requestBody.email
          roles: requestBody.roles
      - text: Send an admin invitation to {email} with metadata {metadata} and roles {roles}.
        slots:
          email: requestBody.email
          metadata: requestBody.metadata
          roles: requestBody.roles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/invite/{invitationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin account invitation
      effect: read
      questions:
      - Has a particular admin invitation been accepted?
      - Can I view one admin account invitation?
      instructions:
      - text: Get admin invitation {invitationId}.
        slots:
          invitationId: path.invitationId
      - text: Show the status of admin invite {invitationId}.
        slots:
          invitationId: path.invitationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/invite/{invitationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an admin account invitation
      effect: destructive
      questions:
      - How do I withdraw an invitation sent to a would-be administrator?
      - Can I revoke an admin invite before it is accepted?
      instructions:
      - text: Revoke admin invitation {invitationId}.
        slots:
          invitationId: path.invitationId
      - text: Cancel the administrator invite {invitationId}.
        slots:
          invitationId: path.invitationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/invite/{invitationId}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend an admin account invitation
      effect: write
      questions:
      - Can I send an admin invitation email again?
      - Does resending an admin invite refresh its expiry?
      instructions:
      - text: Resend admin invitation {invitationId}.
        slots:
          invitationId: path.invitationId
      - text: Send administrator invite {invitationId} one more time.
        slots:
          invitationId: path.invitationId
      method: generated
      generated: '2026-10-01'