Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BugSnag - Data Access SCIM API

12 actions 12 updates phrasing extends openapi/bugsnag-scim-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 12

$.info

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

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

$.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].get

$.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].put

$.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].delete

$.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].patch

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

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

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

$.paths['/organizations/{organization_id}/scim/v2/Groups/{id}'].delete

$.paths['/organizations/{organization_id}/scim/v2/Groups/{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 BugSnag - Data Access SCIM API
  version: 1.0.0
extends: openapi/bugsnag-scim-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: 11
- target: $.paths['/organizations/{organization_id}/scim/v2/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM-provisioned users
      effect: read
      questions:
      - How does my identity provider list the users provisioned in BugSnag via SCIM?
      - Can I look up a SCIM user by exact userName?
      - What is the maximum page size for SCIM user listings?
      instructions:
      - text: List SCIM users in organization {organization_id} starting at {startIndex}, {itemsPerPage} per page.
        slots:
          organization_id: path.organization_id
          startIndex: query.startIndex
          itemsPerPage: query.itemsPerPage
      - text: Find the SCIM user matching {filter} in organization {organization_id}, from index {startIndex} with {itemsPerPage} results.
        slots:
          filter: query.filter
          organization_id: path.organization_id
          startIndex: query.startIndex
          itemsPerPage: query.itemsPerPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a user via SCIM
      effect: write
      questions:
      - How do I provision a new user into BugSnag from my identity provider?
      - Can SCIM create collaborators in my organization automatically?
      instructions:
      - text: Provision a new SCIM user in organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Create a collaborator through SCIM for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM-provisioned user
      effect: read
      questions:
      - How do I fetch one SCIM user record by its ID?
      - Is a particular provisioned user still active?
      instructions:
      - text: Show SCIM user {id} in organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      - text: Get the SCIM record for user {id} from organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM user's details
      effect: write
      questions:
      - How do I update a provisioned user's name and email through SCIM?
      - Can a full SCIM user replace also deactivate the user?
      instructions:
      - text: Replace SCIM user {id} in organization {organization_id} with userName {userName} and emails {emails}.
        slots:
          id: path.id
          organization_id: path.organization_id
          userName: requestBody.userName
          emails: requestBody.emails
      - text: Set SCIM user {id} in organization {organization_id} to name {name} and active {active}.
        slots:
          id: path.id
          organization_id: path.organization_id
          name: requestBody.name
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deprovision a SCIM user
      effect: destructive
      questions:
      - How does my identity provider remove a user from BugSnag via SCIM?
      - Can I delete a provisioned collaborator through SCIM?
      instructions:
      - text: Deprovision SCIM user {id} from organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      - text: Delete SCIM collaborator {id} in organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Users/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Deactivate or re-add a SCIM user
      effect: write
      questions:
      - Can I toggle the active flag to remove and later re-add a provisioned user?
      - How do I apply SCIM patch operations to a single user?
      instructions:
      - text: Apply SCIM patch operations {Operations} to user {id} in organization {organization_id}.
        slots:
          Operations: requestBody.Operations
          id: path.id
          organization_id: path.organization_id
      - text: Reactivate previously removed SCIM user {id} in organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM groups
      effect: read
      questions:
      - Which SCIM groups are synced into my BugSnag organization?
      - Can I find a SCIM group by its display name?
      instructions:
      - text: List SCIM groups in organization {organization_id} from index {startIndex}, {itemsPerPage} per page.
        slots:
          organization_id: path.organization_id
          startIndex: query.startIndex
          itemsPerPage: query.itemsPerPage
      - text: Find SCIM groups matching {filter} in organization {organization_id}, starting at {startIndex} with {itemsPerPage} results.
        slots:
          filter: query.filter
          organization_id: path.organization_id
          startIndex: query.startIndex
          itemsPerPage: query.itemsPerPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SCIM group
      effect: write
      questions:
      - How do I push a new group from my identity provider into BugSnag?
      - Are members added automatically when a SCIM group is created?
      instructions:
      - text: Create SCIM group {displayName} in organization {organization_id}.
        slots:
          displayName: requestBody.displayName
          organization_id: path.organization_id
      - text: Add an empty SCIM group named {displayName} to organization {organization_id}.
        slots:
          displayName: requestBody.displayName
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM group
      effect: read
      questions:
      - Who belongs to a particular SCIM group?
      - How do I fetch one SCIM group by ID?
      instructions:
      - text: Show SCIM group {id} in organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      - text: Get the members of SCIM group {id} in organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SCIM group
      effect: destructive
      questions:
      - Can I remove a group that was provisioned through SCIM?
      - How do I delete a SCIM group from my organization?
      instructions:
      - text: Delete SCIM group {id} from organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      - text: Remove the SCIM-synced group {id} in organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/scim/v2/Groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a SCIM group's name or members
      effect: write
      questions:
      - How do I add or remove members of a SCIM group?
      - Can I rename a SCIM group with a patch operation?
      instructions:
      - text: Apply {op} with value {value} to SCIM group {id} in organization {organization_id}.
        slots:
          op: requestBody.op
          value: requestBody.value
          id: path.id
          organization_id: path.organization_id
      - text: Run SCIM {op} on path {path} of group {id} in organization {organization_id} using {value}.
        slots:
          op: requestBody.op
          path: requestBody.path
          id: path.id
          organization_id: path.organization_id
          value: requestBody.value
      method: generated
      generated: '2026-09-26'