Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Users.on Premises Sync Behavior API

4 actions 4 updates phrasing extends openapi/azure-ad-users-onpremisessyncbehavior-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/users/{user-id}/onPremisesSyncBehavior'].get
$.paths['/users/{user-id}/onPremisesSyncBehavior'].delete
$.paths['/users/{user-id}/onPremisesSyncBehavior'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Users.on Premises Sync Behavior API
  version: 1.0.0
extends: openapi/azure-ad-users-onpremisessyncbehavior-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/users/{user-id}/onPremisesSyncBehavior'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's on-premises sync behavior
      effect: read
      questions:
      - Is this user managed in the cloud or still synced from on-premises?
      - Where do I check a user's on-premises sync behavior setting?
      instructions:
      - text: Get the on-premises sync behavior of user {user}.
        slots:
          user: path.user-id
      - text: Check whether user {user} is cloud managed.
        slots:
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/onPremisesSyncBehavior'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's on-premises sync behavior
      effect: destructive
      questions:
      - Can I delete the on-premises sync behavior object on a user?
      - How do I clear a user's sync behavior setting entirely?
      instructions:
      - text: Delete the on-premises sync behavior of user {user}.
        slots:
          user: path.user-id
      - text: Remove user {user}'s sync behavior if its ETag is {etag}.
        slots:
          user: path.user-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/onPremisesSyncBehavior'].patch
  update:
    x-apievangelist-phrasing:
      intent: Switch a user between cloud and on-premises management
      effect: write
      questions:
      - How do I make a synced user cloud managed instead of on-premises managed?
      - Can I change a user's source of authority back to on-premises?
      instructions:
      - text: Set cloud managed to {cloudManaged} for user {user}.
        slots:
          cloudManaged: requestBody.isCloudManaged
          user: path.user-id
      - text: Make user {user} cloud managed.
        slots:
          user: path.user-id
      method: generated
      generated: '2026-10-01'