# 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 Organization API
  version: 1.0.0
extends: openapi/strivacity-organization-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}/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations in an identity store
      effect: read
      questions:
      - Which B2B organizations exist in an identity store?
      - Can I find an organization by its route or unique identifier?
      instructions:
      - text: List the organizations in identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Find the organization with route {route} in {identityStoreName}.
        slots:
          route: query.route
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization
      effect: write
      questions:
      - How do I onboard a new business customer as an organization?
      - Can I nest a new organization under a parent organization?
      instructions:
      - text: Create organization {name} in {identityStoreName} with routes {routes}.
        slots:
          name: requestBody.name
          identityStoreName: path.identityStoreName
          routes: requestBody.routes
      - text: Add organization {name} under parent {parent} in identity store {identityStoreName}.
        slots:
          name: requestBody.name
          parent: requestBody.parent
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/organizations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization
      effect: read
      questions:
      - How do I view the configuration and routes of one organization?
      - What metadata is stored on a specific organization?
      instructions:
      - text: Show organization {id} in identity store {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      - text: Get the details of organization {id} in {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/organizations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization
      effect: write
      questions:
      - How do I change the routes of an existing organization?
      - Can I move an organization under a different parent?
      instructions:
      - text: Update organization {id} in {identityStoreName} to use routes {routes}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
          routes: requestBody.routes
      - text: Rename existing organization {id} in identity store {identityStoreName} to {name}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/organizations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization
      effect: destructive
      questions:
      - Why can't I delete an organization that still has accounts?
      - How do I remove an organization no longer in use?
      instructions:
      - text: Delete organization {id} from identity store {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      - text: Remove the empty organization {id} in {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'