# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contentstack SCIM SCIM Users API
  version: 1.0.0
extends: openapi/contentstack-scim-users-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['/scim/v2.0/organizations/{organization_uid}/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM users in an organization
      effect: read
      questions:
      - How does my IdP list Contentstack users over SCIM?
      - Can I find a SCIM user by email address with a filter?
      instructions:
      - text: List the SCIM users in organization {org}.
        slots:
          org: path.organization_uid
      - text: Find SCIM users in org {org} matching {filter}.
        slots:
          org: path.organization_uid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a user via SCIM
      effect: write
      questions:
      - How do I provision a new Contentstack user from my identity provider?
      - Which role does a SCIM-provisioned user get by default?
      instructions:
      - text: Provision SCIM user {user_name} in organization {org}.
        slots:
          user_name: requestBody.userName
          org: path.organization_uid
      - text: Create SCIM user {user_name} named {name} with emails {emails} in org {org}.
        slots:
          user_name: requestBody.userName
          name: requestBody.name
          emails: requestBody.emails
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Users/{user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM user
      effect: read
      questions:
      - How do I fetch a single SCIM user resource by ID?
      - Is a given SCIM user still active in my organization?
      instructions:
      - text: Get SCIM user {user} in organization {org}.
        slots:
          user: path.user_id
          org: path.organization_uid
      - text: Show the SCIM user record {user} for org {org}.
        slots:
          user: path.user_id
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Users/{user_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM user's full record
      effect: write
      questions:
      - What happens to attributes I omit when fully replacing a SCIM user?
      - How do I overwrite an entire SCIM user resource from my IdP?
      instructions:
      - text: Replace SCIM user {user} in org {org} with username {user_name}.
        slots:
          user: path.user_id
          org: path.organization_uid
          user_name: requestBody.userName
      - text: Overwrite SCIM user {user} in org {org} with name {name}, emails {emails} and active {active}.
        slots:
          user: path.user_id
          org: path.organization_uid
          name: requestBody.name
          emails: requestBody.emails
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Users/{user_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate, deactivate or patch a SCIM user
      effect: write
      questions:
      - How do I deactivate a Contentstack user through SCIM without replacing the record?
      - Can I update just one attribute of a SCIM user?
      instructions:
      - text: Apply SCIM patch operations {operations} to user {user} in org {org}.
        slots:
          operations: requestBody.Operations
          user: path.user_id
          org: path.organization_uid
      - text: Patch SCIM user {user} in organization {org} to deactivate them using {operations}.
        slots:
          user: path.user_id
          org: path.organization_uid
          operations: requestBody.Operations
      method: generated
      generated: '2026-09-26'