# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Common Room SCIM API
  version: 1.0.0
extends: openapi/common-room-scim-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: 4
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List active owner accounts via SCIM
      effect: read
      questions:
      - Which active owners are provisioned in our community through SCIM?
      - Can I filter the SCIM user list and page through it?
      instructions:
      - text: List the active SCIM owner accounts.
      - text: List SCIM users matching {filter}.
        slots:
          filter: query.filter
      - text: Show {count} SCIM users starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a new owner account via SCIM
      effect: write
      questions:
      - How do I provision a new owner in our community from our identity provider?
      - Can I create a SCIM user who doesn't yet have a login account?
      instructions:
      - text: Provision SCIM user {userName} with emails {emails}.
        slots:
          userName: requestBody.userName
          emails: requestBody.emails
      - text: Create owner account {userName} named {name} with active set to {active}.
        slots:
          userName: requestBody.userName
          name: requestBody.name
          active: requestBody.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM user account by email
      effect: read
      questions:
      - Can I retrieve one provisioned SCIM account by its email?
      - Is a specific person provisioned as a user in our community?
      instructions:
      - text: Get the SCIM user account for {email}.
        slots:
          email: path.email
      - text: Check whether {email} has a provisioned user account.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{email}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a SCIM user account
      effect: write
      questions:
      - How do I deactivate or change a provisioned user through SCIM?
      - What patch operations can I send to update a SCIM account?
      instructions:
      - text: Update SCIM user {email} with operations {Operations}.
        slots:
          email: path.email
          Operations: requestBody.Operations
      - text: Apply the patch {Operations} to the account for {email}.
        slots:
          Operations: requestBody.Operations
          email: path.email
      method: generated
      generated: '2026-10-01'