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

API Evangelist conversational phrasing for Identity.SignIns Tenant Relationships.multi Tenant…

11 actions 11 updates phrasing extends openapi/azure-ad-tenantrelationships-multitenantorganization-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 11

$.info
$.paths['/tenantRelationships/multiTenantOrganization'].get
$.paths['/tenantRelationships/multiTenantOrganization'].patch
$.paths['/tenantRelationships/multiTenantOrganization/joinRequest'].get
$.paths['/tenantRelationships/multiTenantOrganization/joinRequest'].patch
$.paths['/tenantRelationships/multiTenantOrganization/tenants'].get
$.paths['/tenantRelationships/multiTenantOrganization/tenants'].post
$.paths['/tenantRelationships/multiTenantOrganization/tenants/{multiTenantOrganizationMember-id}'].get
$.paths['/tenantRelationships/multiTenantOrganization/tenants/{multiTenantOrganizationMember-id}'].delete
$.paths['/tenantRelationships/multiTenantOrganization/tenants/{multiTenantOrganizationMember-id}'].patch
$.paths['/tenantRelationships/multiTenantOrganization/tenants/$count'].get

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 Identity.SignIns Tenant Relationships.multi Tenant…
  version: 1.0.0
extends: openapi/azure-ad-tenantrelationships-multitenantorganization-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: 10
- target: $.paths['/tenantRelationships/multiTenantOrganization'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the multitenant organization
      effect: read
      questions:
      - What are the properties of the multitenant organization my tenant belongs to?
      - Can I see the state and display name of our multitenant organization?
      instructions:
      - text: Show our multitenant organization's details.
      - text: Get the multitenant organization and expand {expand}.
        slots:
          expand: query.$expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the multitenant organization
      effect: write
      questions:
      - How do I rename our multitenant organization?
      - Can I change the description on the multitenant organization itself?
      instructions:
      - text: Rename the multitenant organization to {displayName}.
        slots:
          displayName: requestBody.displayName
      - text: Set the multitenant organization description to {description}.
        slots:
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/joinRequest'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my tenant's join request status
      effect: read
      questions:
      - Has my tenant finished joining the multitenant organization yet?
      - Where can I see the status of our join request to a multitenant organization?
      instructions:
      - text: Check the status of our tenant's multitenant organization join request.
      - text: Show the join request record including {select}.
        slots:
          select: query.$select
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/joinRequest'].patch
  update:
    x-apievangelist-phrasing:
      intent: Join a multitenant organization
      effect: write
      questions:
      - My tenant was added as pending to a multitenant organization; how do I actually join it?
      - What does the joining tenant's admin have to submit to participate?
      instructions:
      - text: Submit a join request to the multitenant organization owned by tenant {addedByTenantId}.
        slots:
          addedByTenantId: requestBody.addedByTenantId
      - text: Join the multitenant organization with member state {memberState}.
        slots:
          memberState: requestBody.memberState
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenants in the multitenant organization
      effect: read
      questions:
      - Which tenants are members of our multitenant organization?
      - Can I see which member tenants are still pending?
      instructions:
      - text: List all member tenants of the multitenant organization.
      - text: Show multitenant organization members matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/tenants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tenant to the multitenant organization
      effect: write
      questions:
      - How do I invite another tenant into our multitenant organization?
      - Does an added tenant stay pending until its admin joins?
      instructions:
      - text: Add tenant {tenantId} to our multitenant organization.
        slots:
          tenantId: requestBody.tenantId
      - text: Add tenant {tenantId} named {displayName} to the multitenant organization with role {role}.
        slots:
          tenantId: requestBody.tenantId
          displayName: requestBody.displayName
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/tenants/{multiTenantOrganizationMember-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one member tenant
      effect: read
      questions:
      - What role and state does a specific member tenant have in the multitenant organization?
      - When did a particular tenant join our multitenant organization?
      instructions:
      - text: Get member tenant {member} of the multitenant organization.
        slots:
          member: path.multiTenantOrganizationMember-id
      - text: Show the role and join date for tenant member {member}.
        slots:
          member: path.multiTenantOrganizationMember-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/tenants/{multiTenantOrganizationMember-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tenant from the multitenant organization
      effect: destructive
      questions:
      - Can I remove a tenant from our multitenant organization?
      - In which scenarios is a member tenant allowed to be removed?
      instructions:
      - text: Remove tenant member {member} from the multitenant organization.
        slots:
          member: path.multiTenantOrganizationMember-id
      - text: Kick {member} out of our multitenant organization.
        slots:
          member: path.multiTenantOrganizationMember-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/tenants/{multiTenantOrganizationMember-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a member tenant
      effect: write
      questions:
      - How do I promote a member tenant to an owner in the multitenant organization?
      - Can only owner tenants change another member's properties?
      instructions:
      - text: Change member tenant {member}'s role to {role}.
        slots:
          member: path.multiTenantOrganizationMember-id
          role: requestBody.role
      - text: Update the display name of member tenant {member} to {displayName}.
        slots:
          member: path.multiTenantOrganizationMember-id
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenantRelationships/multiTenantOrganization/tenants/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count tenants in the multitenant organization
      effect: read
      questions:
      - How many tenants belong to our multitenant organization?
      - Can I get a count of member tenants matching a filter?
      instructions:
      - text: Count the member tenants of the multitenant organization.
      - text: Tell me how many member tenants match {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'