# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST User SCIM API
  version: 1.0.0
extends: openapi/cvent-user-scim-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/scim/v2/Groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM groups representing user roles
      effect: read
      questions:
      - Which user roles are exposed as SCIM groups in my account?
      - Can I page through SCIM groups with startIndex and count?
      instructions:
      - text: List the SCIM groups in my account.
      - text: Show {count} SCIM role groups starting at {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/ResourceTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported SCIM resource types
      effect: read
      questions:
      - What SCIM resource types does Cvent support?
      - Which resource types can my identity provider provision?
      instructions:
      - text: List the SCIM resource types.
      - text: Show every resource type the SCIM service exposes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/ResourceTypes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SCIM resource type
      effect: read
      questions:
      - What endpoint and schema does the User resource type use?
      - Can I look up the definition of a single SCIM resource type?
      instructions:
      - text: Get SCIM resource type {id}.
        slots:
          id: path.id
      - text: Show the endpoint and schema for resource type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM user and group schemas
      effect: read
      questions:
      - What SCIM schemas and extensions describe users and groups?
      - Where can I see all attribute schemas the SCIM API supports?
      instructions:
      - text: List the SCIM schemas.
      - text: Show all user and group schema definitions with their extensions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Schemas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SCIM schema definition
      effect: read
      questions:
      - Which attributes are in the enterprise user extension schema?
      - Can I fetch a single SCIM schema by its URN?
      instructions:
      - text: Get SCIM schema {id}.
        slots:
          id: path.id
      - text: Show the attributes defined in schema {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/ServiceProviderConfig'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the SCIM service provider configuration
      effect: read
      questions:
      - Does the SCIM service support filtering, patch or bulk operations?
      - What authentication schemes does Cvent's SCIM configuration advertise?
      instructions:
      - text: Get the SCIM service provider configuration.
      - text: Show which SCIM features the service provider config says are supported.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List provisioned users
      effect: read
      questions:
      - Which users are provisioned in my account through SCIM?
      - Can I find a user by userName with a SCIM filter?
      instructions:
      - text: List SCIM users.
      - text: Find SCIM users matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a new user
      effect: write
      questions:
      - How do I provision a new user account through SCIM?
      - Will a newly created user's email need to be verified?
      instructions:
      - text: Create a SCIM user {userName} with emails {emails}.
        slots:
          userName: requestBody.userName
          emails: requestBody.emails
      - text: Provision user {userName} in groups {groups} with timezone {timezone}.
        slots:
          userName: requestBody.userName
          groups: requestBody.groups
          timezone: requestBody.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one provisioned user
      effect: read
      questions:
      - What roles and email does a specific user have?
      - Can I look up a single SCIM user by ID?
      instructions:
      - text: Get SCIM user {id}.
        slots:
          id: path.id
      - text: Show the profile of provisioned user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a provisioned user
      effect: write
      questions:
      - Can I deactivate a user by updating their active flag?
      - What happens if I change a user's email address through SCIM?
      instructions:
      - text: Set SCIM user {id}'s active status to {active}.
        slots:
          id: path.id
          active: requestBody.active
      - text: Update existing user {id} to groups {groups}.
        slots:
          id: path.id
          groups: requestBody.groups
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provisioned user
      effect: destructive
      questions:
      - How do I deprovision a user who left the company?
      - Can I delete a user through SCIM?
      instructions:
      - text: Delete SCIM user {id}.
        slots:
          id: path.id
      - text: Deprovision and remove user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'