Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry SCIM SCIM Members API

6 actions 6 updates phrasing extends openapi/sentry-system-scim-members-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/Users'].get

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

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

$.paths['/organizations/{organization_id_or_slug}/scim/v2/Users/{scim_user_id}'].delete

$.paths['/organizations/{organization_id_or_slug}/scim/v2/Users/{scim_user_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 Members API
  version: 1.0.0
extends: openapi/sentry-system-scim-members-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/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List members via SCIM
      effect: read
      questions:
      - How does my identity provider list Sentry members over SCIM?
      - Can I filter SCIM users by userName?
      instructions:
      - text: List SCIM members of {org}.
        slots:
          org: path.organization_id_or_slug
      - text: List SCIM users in {org} matching filter {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/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a member via SCIM
      effect: write
      questions:
      - How do I auto-provision a new user into Sentry from our IdP?
      - What SCIM schema fields are needed to create a member?
      instructions:
      - text: Provision SCIM user {userName} in {org} with schemas {schemas}.
        slots:
          userName: requestBody.userName
          org: path.organization_id_or_slug
          schemas: requestBody.schemas
      - text: Create SCIM member {userName} with emails {emails} and active {active}, schemas {schemas}.
        slots:
          userName: requestBody.userName
          emails: requestBody.emails
          active: requestBody.active
          schemas: requestBody.schemas
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/scim/v2/Users/{scim_user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a member via SCIM
      effect: read
      questions:
      - Can I look up one SCIM user's record?
      - What does Sentry return for a single SCIM member?
      instructions:
      - text: Get SCIM user {scim_user_id} in {org}.
        slots:
          scim_user_id: path.scim_user_id
          org: path.organization_id_or_slug
      - text: Fetch the SCIM record for user {scim_user_id}.
        slots:
          scim_user_id: path.scim_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/scim/v2/Users/{scim_user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deprovision a member via SCIM
      effect: destructive
      questions:
      - How does offboarding in our IdP remove someone from Sentry?
      - Is a SCIM delete a full removal of the member?
      instructions:
      - text: Deprovision SCIM user {scim_user_id} from {org}.
        slots:
          scim_user_id: path.scim_user_id
          org: path.organization_id_or_slug
      - text: Delete SCIM member {scim_user_id}.
        slots:
          scim_user_id: path.scim_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/scim/v2/Users/{scim_user_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a member via SCIM patch
      effect: write
      questions:
      - Can I deactivate a user through SCIM without deleting them?
      - Which SCIM user attributes can be patched?
      instructions:
      - text: Patch SCIM user {scim_user_id} in {org} with operations {Operations} and schemas {schemas}.
        slots:
          scim_user_id: path.scim_user_id
          org: path.organization_id_or_slug
          Operations: requestBody.Operations
          schemas: requestBody.schemas
      - text: Set SCIM user {scim_user_id} inactive using operations {Operations} under schemas {schemas}.
        slots:
          scim_user_id: path.scim_user_id
          Operations: requestBody.Operations
          schemas: requestBody.schemas
      method: generated
      generated: '2026-09-26'