# 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-event-cloud-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 (user roles)
      effect: read
      questions:
      - Which Cvent user roles are exposed as SCIM groups?
      - Can I page through SCIM groups with a start index and count?
      instructions:
      - text: List the SCIM groups in my account.
      - text: Get {count} SCIM role groups starting at index {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 SCIM resource types
      effect: read
      questions:
      - What SCIM resource types does the service support?
      - Which resource types can my identity provider provision?
      instructions:
      - text: List the SCIM resource types.
      - text: Show every resource type the SCIM endpoint supports.
      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 a given SCIM resource type use?
      - Can I fetch the definition of a single resource type like User?
      instructions:
      - text: Get SCIM resource type {id}.
        slots:
          id: path.id
      - text: Show the definition of 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 role groups?
      - Which attributes are available in the user schema extensions?
      instructions:
      - text: List the SCIM schemas.
      - text: Show all user schemas and their extension models.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Schemas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SCIM schema
      effect: read
      questions:
      - What attributes are defined in a specific SCIM schema?
      - Can I look up the enterprise user extension schema by its URN?
      instructions:
      - text: Get SCIM schema {id}.
        slots:
          id: path.id
      - text: Show the attribute definitions of 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?
      - What SCIM capabilities and auth schemes are configured?
      instructions:
      - text: Get the SCIM service provider config.
      - text: Show which SCIM features the provisioning service supports.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List provisioned users via SCIM
      effect: read
      questions:
      - Which users are provisioned in my Cvent account over SCIM?
      - Can I find a SCIM user by userName with a filter?
      instructions:
      - text: List SCIM users.
      - text: Find SCIM users matching filter {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 via SCIM
      effect: write
      questions:
      - How do I provision a new Cvent user from my identity provider?
      - Why is a new account user's email unverified after creation?
      instructions:
      - text: Provision user {userName} with email {emails} in role groups {groups}.
        slots:
          userName: requestBody.userName
          emails: requestBody.emails
          groups: requestBody.groups
      - text: Create an active {userType} user {userName} in timezone {timezone} and locale {locale}.
        slots:
          userType: requestBody.userType
          userName: requestBody.userName
          timezone: requestBody.timezone
          locale: requestBody.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SCIM user
      effect: read
      questions:
      - What attributes are stored for a specific provisioned user?
      - Can I fetch a single SCIM user by ID?
      instructions:
      - text: Get SCIM user {id}.
        slots:
          id: path.id
      - text: Show the provisioned profile of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM user's attributes
      effect: write
      questions:
      - How do I deactivate a provisioned user through SCIM?
      - Do I need to re-verify an email address after changing it on a user?
      instructions:
      - text: Set SCIM user {id} active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      - text: Update user {id}'s role groups to {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 SCIM user
      effect: destructive
      questions:
      - How do I deprovision a user completely via SCIM?
      - Can I delete a Cvent user from my identity provider?
      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'