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

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

4 actions 4 updates phrasing extends openapi/azure-ad-groups-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['/groups/{group-id}/onPremisesSyncBehavior'].get
$.paths['/groups/{group-id}/onPremisesSyncBehavior'].delete
$.paths['/groups/{group-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 Groups.on Premises Sync Behavior API
  version: 1.0.0
extends: openapi/azure-ad-groups-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['/groups/{group-id}/onPremisesSyncBehavior'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a group is cloud-managed or synced
      effect: read
      questions:
      - How can I tell if a group's source of authority is still on-premises Active Directory?
      - Is this group marked as cloud-managed instead of synced from on-prem?
      instructions:
      - text: Show the on-premises sync behavior for group {group_id}.
        slots:
          group_id: path.group-id
      - text: Tell me whether group {group_id} is managed in the cloud or by on-prem sync.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/onPremisesSyncBehavior'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group's on-premises sync behavior setting
      effect: destructive
      questions:
      - Can I clear the on-premises sync behavior object from a group entirely?
      - What happens if I delete a group's onPremisesSyncBehavior setting?
      instructions:
      - text: Delete the on-premises sync behavior setting from group {group_id}.
        slots:
          group_id: path.group-id
      - text: Remove the sync-behavior object on group {group_id}, matching ETag {etag}.
        slots:
          group_id: path.group-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/onPremisesSyncBehavior'].patch
  update:
    x-apievangelist-phrasing:
      intent: Switch a group between cloud-managed and on-prem synced
      effect: write
      questions:
      - How do I move a synced group's source of authority to the cloud?
      - Can I flip a group back so on-premises sync manages it again?
      instructions:
      - text: Set isCloudManaged to {is_cloud_managed} for group {group_id}.
        slots:
          is_cloud_managed: requestBody.isCloudManaged
          group_id: path.group-id
      - text: Make group {group_id} cloud-managed so on-prem sync stops owning it.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'