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

API Evangelist conversational phrasing for Identity.DirectoryManagement Contacts.on Premises Sync…

4 actions 4 updates phrasing extends openapi/azure-ad-contacts-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['/contacts/{orgContact-id}/onPremisesSyncBehavior'].get

$.paths['/contacts/{orgContact-id}/onPremisesSyncBehavior'].delete

$.paths['/contacts/{orgContact-id}/onPremisesSyncBehavior'].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 Identity.DirectoryManagement Contacts.on Premises Sync…
  version: 1.0.0
extends: openapi/azure-ad-contacts-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['/contacts/{orgContact-id}/onPremisesSyncBehavior'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an org contact's on-premises sync behavior
      effect: read
      questions:
      - Is a given organizational contact still managed from on-premises Active Directory or from the cloud?
      - How can I see the sync source-of-authority setting for an org contact?
      instructions:
      - text: Show the on-premises sync behavior for org contact {orgContact}.
        slots:
          orgContact: path.orgContact-id
      - text: Check whether contact {orgContact} is cloud managed.
        slots:
          orgContact: path.orgContact-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{orgContact-id}/onPremisesSyncBehavior'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an org contact's sync behavior setting
      effect: destructive
      questions:
      - Can I clear the on-premises sync behavior object from an organizational contact?
      - What happens if I delete the sync behavior setting on a contact?
      instructions:
      - text: Delete the on-premises sync behavior setting from org contact {orgContact}.
        slots:
          orgContact: path.orgContact-id
      - text: Clear the sync behavior object on contact {orgContact}.
        slots:
          orgContact: path.orgContact-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{orgContact-id}/onPremisesSyncBehavior'].patch
  update:
    x-apievangelist-phrasing:
      intent: Switch an org contact to cloud management
      effect: write
      questions:
      - How do I move an organizational contact's source of authority from on-premises AD to the cloud?
      - Can I flip an org contact back to being managed by on-premises sync?
      instructions:
      - text: Set cloud managed to {isCloudManaged} for org contact {orgContact}.
        slots:
          isCloudManaged: requestBody.isCloudManaged
          orgContact: path.orgContact-id
      - text: Make contact {orgContact} cloud managed instead of synced from on-premises.
        slots:
          orgContact: path.orgContact-id
      method: generated
      generated: '2026-10-01'