Braze · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Braze scim

6 actions 6 updates documentation extends openapi/braze-scim-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-apievangelist-providerx-apievangelist-artifactsx-apievangelist-operation-ids

Targets 6

$.info

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

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

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

$.paths['/scim/v2/Users'].get

$.paths['/scim/v2/Users'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Braze scim
  version: 1.0.0
extends: openapi/braze-scim-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: openapi/braze-scim-api-openapi.yml
x-note: The harvested Braze specs declare no operationId on any operation. This overlay proposes one per
  operation, derived deterministically from the operation's own summary, plus provider-wide metadata.
  It is an API Evangelist enhancement, NOT a Braze-published identifier — do not treat these ids as canonical
  Braze operation names. The original spec is never mutated.
actions:
- target: $.info
  update:
    x-apievangelist-provider: braze
    x-apievangelist-artifacts:
      authentication: authentication/braze-authentication.yml
      conventions: conventions/braze-conventions.yml
      errors: errors/braze-problem-types.yml
      rate-limits: rate-limits/braze-rate-limits.yml
      lifecycle: lifecycle/braze-lifecycle.yml
      data-model: data-model/braze-data-model.yml
      mcp: mcp/braze-mcp.yml
    x-apievangelist-operation-ids: proposed by overlay; absent from the source spec
- target: $.paths['/scim/v2/Users/{id}'].delete
  update:
    operationId: removeDashboardUserAccount
- target: $.paths['/scim/v2/Users/{id}'].get
  update:
    operationId: lookUpAnExistingDashboardUserAccount
- target: $.paths['/scim/v2/Users/{id}'].put
  update:
    operationId: updateDashboardUserAccount
- target: $.paths['/scim/v2/Users'].get
  update:
    operationId: searchExistingDashboardUserByEmail
- target: $.paths['/scim/v2/Users'].post
  update:
    operationId: createNewDashboardUserAccount