Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry SCIM SCIM Teams API

6 actions 6 updates phrasing extends openapi/sentry-system-scim-teams-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

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

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

$.paths['/organizations/{organization_id_or_slug}/scim/v2/Groups/{scim_group_id}'].get

$.paths['/organizations/{organization_id_or_slug}/scim/v2/Groups/{scim_group_id}'].delete

$.paths['/organizations/{organization_id_or_slug}/scim/v2/Groups/{scim_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 Sentry SCIM SCIM Teams API
  version: 1.0.0
extends: openapi/sentry-system-scim-teams-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['/organizations/{organization_id_or_slug}/scim/v2/Groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams via SCIM
      effect: read
      questions:
      - How does my IdP see Sentry teams as SCIM groups?
      - Can I filter SCIM groups by display name?
      instructions:
      - text: List SCIM groups in {org}.
        slots:
          org: path.organization_id_or_slug
      - text: List SCIM teams in {org} matching {filter}, {count} per page from index {startIndex}.
        slots:
          org: path.organization_id_or_slug
          filter: query.filter
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/scim/v2/Groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a team via SCIM
      effect: write
      questions:
      - How do I create a Sentry team from an IdP group?
      - Can I add members when provisioning a SCIM group?
      instructions:
      - text: Provision SCIM team {displayName} in {org} with schemas {schemas}.
        slots:
          displayName: requestBody.displayName
          org: path.organization_id_or_slug
          schemas: requestBody.schemas
      - text: Create SCIM group {displayName} with members {members}, schemas {schemas}.
        slots:
          displayName: requestBody.displayName
          members: requestBody.members
          schemas: requestBody.schemas
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/scim/v2/Groups/{scim_group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team via SCIM
      effect: read
      questions:
      - Can I read one team's SCIM group record?
      - Which members does a SCIM group currently have?
      instructions:
      - text: Get SCIM group {scim_group_id} in {org}.
        slots:
          scim_group_id: path.scim_group_id
          org: path.organization_id_or_slug
      - text: Fetch SCIM team {scim_group_id}.
        slots:
          scim_group_id: path.scim_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/scim/v2/Groups/{scim_group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a team via SCIM
      effect: destructive
      questions:
      - What happens in Sentry when an IdP group is deleted?
      - Can SCIM remove a whole team?
      instructions:
      - text: Delete SCIM group {scim_group_id} from {org}.
        slots:
          scim_group_id: path.scim_group_id
          org: path.organization_id_or_slug
      - text: Remove SCIM team {scim_group_id}.
        slots:
          scim_group_id: path.scim_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/scim/v2/Groups/{scim_group_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a team or its members via SCIM
      effect: write
      questions:
      - How do I sync group membership changes into a Sentry team?
      - Can I rename a team through a SCIM patch?
      instructions:
      - text: Patch SCIM group {scim_group_id} in {org} with operations {Operations}, schemas {schemas}.
        slots:
          scim_group_id: path.scim_group_id
          org: path.organization_id_or_slug
          Operations: requestBody.Operations
          schemas: requestBody.schemas
      - text: Apply member changes {Operations} to SCIM team {scim_group_id} under schemas {schemas}.
        slots:
          Operations: requestBody.Operations
          scim_group_id: path.scim_group_id
          schemas: requestBody.schemas
      method: generated
      generated: '2026-09-26'