# 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-registration-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 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 the account.
      - text: Show {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 provisioning endpoint support?
      - Which resource types can my identity provider discover?
      instructions:
      - text: List the SCIM resource types.
      - text: Show every resource type the SCIM service advertises.
      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 does the User resource type definition contain?
      - Can I look up a single SCIM resource type by its ID?
      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?
      - Which attribute schemas does user provisioning use?
      instructions:
      - text: List the SCIM schemas.
      - text: Show all user and group schemas with 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 definition
      effect: read
      questions:
      - What 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, patching or bulk operations?
      - What SCIM features and auth schemes are configured?
      instructions:
      - text: Get the SCIM service provider config.
      - text: Show which SCIM capabilities the service supports.
      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 exist in my account via SCIM?
      - Can I filter SCIM users by username or email?
      instructions:
      - text: List SCIM users.
      - text: Find users matching SCIM 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
      effect: write
      questions:
      - How do I provision a new Cvent user through SCIM?
      - Does a newly created account user need to verify their email?
      instructions:
      - text: Create user {userName} with emails {emails} and roles {groups}.
        slots:
          userName: requestBody.userName
          emails: requestBody.emails
          groups: requestBody.groups
      - text: Provision user {userName} named {name} as type {userType} in time zone {timezone}.
        slots:
          userName: requestBody.userName
          name: requestBody.name
          userType: requestBody.userType
          timezone: requestBody.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's details
      effect: read
      questions:
      - What roles and contact details does a specific user have?
      - Is a given provisioned user active?
      instructions:
      - text: Get SCIM user {id}.
        slots:
          id: path.id
      - text: Show the profile and groups 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: Update a provisioned user
      effect: write
      questions:
      - Can I deactivate a user without deleting them?
      - What happens when I change a user's email address?
      instructions:
      - text: Set user {id} active flag to {active}.
        slots:
          id: path.id
          active: requestBody.active
      - text: Update user {id}'s roles 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 user
      effect: destructive
      questions:
      - How do I deprovision a user completely?
      - Can I remove a user who has left the company?
      instructions:
      - text: Delete user {id}.
        slots:
          id: path.id
      - text: Deprovision and remove SCIM user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'