# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform - User Provisioning Users V3 API
  version: 1.0.0
extends: openapi/onetrust-users-v3-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: 5
- target: $.paths['/api/scim/v3/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM users
      effect: read
      questions:
      - Which users are provisioned in my account over SCIM?
      - Can I filter SCIM users by email or user name?
      instructions:
      - text: List the SCIM users.
      - text: List SCIM users matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a user via SCIM
      effect: write
      questions:
      - Can my identity provider create a user and give them a role?
      - Which fields are needed to provision a new user over SCIM?
      instructions:
      - text: Provision user {userName} with emails {emails}.
        slots:
          userName: requestBody.userName
          emails: requestBody.emails
      - text: Create SCIM user {userName} with roles {roles}.
        slots:
          userName: requestBody.userName
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM user
      effect: read
      questions:
      - Which groups does a specific provisioned user belong to?
      - Can I look up one SCIM user by ID?
      instructions:
      - text: Get SCIM user {id}.
        slots:
          id: path.id
      - text: Show the emails and groups of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM user's attributes
      effect: write
      questions:
      - Can I overwrite all of a user's attributes in one SCIM call?
      - Does a full user update replace fields I leave out?
      instructions:
      - text: Fully replace SCIM user {id} with user name {userName}.
        slots:
          id: path.id
          userName: requestBody.userName
      - text: Overwrite user {id}'s title to {title} and roles to {roles}.
        slots:
          id: path.id
          title: requestBody.title
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Users/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate, deactivate or patch a SCIM user
      effect: write
      questions:
      - Can I deactivate a user through SCIM?
      - Is there a way to change only a couple of a user's attributes?
      instructions:
      - text: Deactivate SCIM user {id}.
        slots:
          id: path.id
      - text: Apply patch operations {Operations} to user {id}.
        slots:
          Operations: requestBody.Operations
          id: path.id
      method: generated
      generated: '2026-09-26'