Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack SCIM SCIM Groups API

7 actions 7 updates phrasing extends openapi/contentstack-scim-groups-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Contentstack's API. It is a proposal applied on top of the contract, not a document Contentstack publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/scim/v2.0/organizations/{organization_uid}/Groups'].get

$.paths['/scim/v2.0/organizations/{organization_uid}/Groups'].post

$.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].get

$.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].put

$.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].delete

$.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].patch

OpenAPI Overlay

# 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 Groups API
  version: 1.0.0
extends: openapi/contentstack-scim-groups-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: 6
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM groups in an organization
      effect: read
      questions:
      - How does my identity provider list the groups in a Contentstack org over SCIM?
      - Can I look up a SCIM group by its display name?
      instructions:
      - text: List the SCIM groups in organization {org}.
        slots:
          org: path.organization_uid
      - text: Find SCIM groups in org {org} matching filter {filter}.
        slots:
          org: path.organization_uid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a group via SCIM
      effect: write
      questions:
      - How do I push a new group from my IdP into Contentstack?
      - Can a SCIM group be created with members already in it?
      instructions:
      - text: Create SCIM group {display_name} in organization {org}.
        slots:
          display_name: requestBody.displayName
          org: path.organization_uid
      - text: Provision SCIM group {display_name} with members {members} in org {org}.
        slots:
          display_name: requestBody.displayName
          members: requestBody.members
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM group
      effect: read
      questions:
      - How do I fetch one SCIM group resource by its ID?
      - What members does a specific SCIM group have?
      instructions:
      - text: Get SCIM group {group} in organization {org}.
        slots:
          group: path.group_id
          org: path.organization_uid
      - text: Show the SCIM group resource {group} for org {org}.
        slots:
          group: path.group_id
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM group and its full membership
      effect: write
      questions:
      - How do I sync a group's entire membership from my IdP in one call?
      - Does replacing a SCIM group overwrite the whole member list?
      instructions:
      - text: Replace SCIM group {group} in org {org} with members {members}.
        slots:
          group: path.group_id
          org: path.organization_uid
          members: requestBody.members
      - text: Overwrite SCIM group {group} in org {org} as {display_name} with members {members}.
        slots:
          group: path.group_id
          org: path.organization_uid
          display_name: requestBody.displayName
          members: requestBody.members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SCIM group
      effect: destructive
      questions:
      - What happens to group members when a SCIM group is deleted?
      - How do I deprovision a group from Contentstack via SCIM?
      instructions:
      - text: Delete SCIM group {group} from organization {org}.
        slots:
          group: path.group_id
          org: path.organization_uid
      - text: Deprovision the SCIM group {group} in org {org}.
        slots:
          group: path.group_id
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scim/v2.0/organizations/{organization_uid}/Groups/{group_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove SCIM group members
      effect: write
      questions:
      - Can I add a single member to a SCIM group without resending the full list?
      - How do I remove one user from a SCIM group with a PATCH?
      instructions:
      - text: Apply SCIM patch operations {operations} to group {group} in org {org}.
        slots:
          operations: requestBody.Operations
          group: path.group_id
          org: path.organization_uid
      - text: Patch SCIM group {group} in organization {org} to add or remove members via {operations}.
        slots:
          group: path.group_id
          org: path.organization_uid
          operations: requestBody.Operations
      method: generated
      generated: '2026-09-26'