Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Integrations External Users API

4 actions 4 updates phrasing extends openapi/sentry-system-external-users-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 4

$.info

$.paths['/organizations/{organization_id_or_slug}/external-users/'].post

$.paths['/organizations/{organization_id_or_slug}/external-users/{external_user_id}/'].put

$.paths['/organizations/{organization_id_or_slug}/external-users/{external_user_id}/'].delete

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 Integrations External Users API
  version: 1.0.0
extends: openapi/sentry-system-external-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: 3
- target: $.paths['/organizations/{organization_id_or_slug}/external-users/'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a member to an external service user
      effect: write
      questions:
      - How do I link a Sentry member to their username in an external tool?
      - What does an external user mapping require?
      instructions:
      - text: Map member {memberId} in {org} to external user {externalName} on {provider}.
        slots:
          memberId: requestBody.memberId
          org: path.organization_id_or_slug
          externalName: requestBody.externalName
          provider: requestBody.provider
      - text: Link member {memberId} to {externalName} through integration {integrationId}.
        slots:
          memberId: requestBody.memberId
          externalName: requestBody.externalName
          integrationId: requestBody.integrationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/external-users/{external_user_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external user mapping
      effect: write
      questions:
      - Can I correct the external username a member is mapped to?
      - How do I change which provider an external user mapping uses?
      instructions:
      - text: Change external user mapping {external_user_id} in {org} to name {externalName}.
        slots:
          external_user_id: path.external_user_id
          org: path.organization_id_or_slug
          externalName: requestBody.externalName
      - text: Set external user {external_user_id} provider to {provider}.
        slots:
          external_user_id: path.external_user_id
          provider: requestBody.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/external-users/{external_user_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an external user mapping
      effect: destructive
      questions:
      - How do I unlink a member from their external account?
      - Is removing an external user mapping safe for the member's Sentry access?
      instructions:
      - text: Delete external user mapping {external_user_id} from {org}.
        slots:
          external_user_id: path.external_user_id
          org: path.organization_id_or_slug
      - text: Remove external user link {external_user_id}.
        slots:
          external_user_id: path.external_user_id
      method: generated
      generated: '2026-09-26'