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

API Evangelist conversational phrasing for Identity.DirectoryManagement Directory.remote Tenant Group…

7 actions 7 updates phrasing extends openapi/azure-ad-directory-remotetenantgroup-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 7

$.info

$.paths['/directory/remoteTenantGroups'].get

$.paths['/directory/remoteTenantGroups'].post

$.paths['/directory/remoteTenantGroups/{remoteTenantGroup-id}'].get

$.paths['/directory/remoteTenantGroups/{remoteTenantGroup-id}'].delete

$.paths['/directory/remoteTenantGroups/{remoteTenantGroup-id}'].patch

$.paths['/directory/remoteTenantGroups/$count'].get

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 Directory.remote Tenant Group…
  version: 1.0.0
extends: openapi/azure-ad-directory-remotetenantgroup-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: 6
- target: $.paths['/directory/remoteTenantGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote tenant groups
      effect: read
      questions:
      - Which groups from other tenants are linked into my directory?
      - Can I search remote tenant groups by display name?
      instructions:
      - text: List all remote tenant groups in the directory.
      - text: List remote tenant groups matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/remoteTenantGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a remote tenant group
      effect: write
      questions:
      - How do I register a group from another tenant as a remote tenant group?
      - What details, like the remote tenant ID and primary domain, do I need to add a remote tenant group?
      instructions:
      - text: Add remote tenant group {group} from tenant {tenant}.
        slots:
          group: requestBody.remoteGroupId
          tenant: requestBody.remoteTenantId
      - text: Create a remote tenant group named {name} for tenant domain {domain}.
        slots:
          name: requestBody.remoteGroupDisplayName
          domain: requestBody.remoteTenantPrimaryDomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/remoteTenantGroups/{remoteTenantGroup-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a remote tenant group
      effect: read
      questions:
      - Can I look up one remote tenant group by its ID?
      - Which tenant does a specific remote tenant group come from?
      instructions:
      - text: Get remote tenant group {id}.
        slots:
          id: path.remoteTenantGroup-id
      - text: Show remote tenant group {id} with only {select}.
        slots:
          id: path.remoteTenantGroup-id
          select: query.$select
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/remoteTenantGroups/{remoteTenantGroup-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote tenant group
      effect: destructive
      questions:
      - Can I remove a remote tenant group from my directory?
      - Is an ETag required to delete a remote tenant group?
      instructions:
      - text: Delete remote tenant group {id}.
        slots:
          id: path.remoteTenantGroup-id
      - text: Remove remote tenant group {id} if ETag {etag} matches.
        slots:
          id: path.remoteTenantGroup-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/remoteTenantGroups/{remoteTenantGroup-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a remote tenant group
      effect: write
      questions:
      - Can I rename a remote tenant group's display name?
      - How do I change the tenant domain recorded on a remote tenant group?
      instructions:
      - text: Rename remote tenant group {id} to {name}.
        slots:
          id: path.remoteTenantGroup-id
          name: requestBody.remoteGroupDisplayName
      - text: Update remote tenant group {id} with tenant domain {domain}.
        slots:
          id: path.remoteTenantGroup-id
          domain: requestBody.remoteTenantPrimaryDomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/remoteTenantGroups/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count remote tenant groups
      effect: read
      questions:
      - How many remote tenant groups does my directory have?
      - Can I count remote tenant groups that match a filter?
      instructions:
      - text: Count remote tenant groups.
      - text: Count remote tenant groups where {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'