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

API Evangelist conversational phrasing for Identity.Governance Agreements.agreement Acceptance API

7 actions 7 updates phrasing extends openapi/azure-ad-agreements-agreementacceptance-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['/agreements/{agreement-id}/acceptances'].get
$.paths['/agreements/{agreement-id}/acceptances'].post
$.paths['/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}'].get
$.paths['/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}'].delete
$.paths['/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}'].patch
$.paths['/agreements/{agreement-id}/acceptances/$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.Governance Agreements.agreement Acceptance API
  version: 1.0.0
extends: openapi/azure-ad-agreements-agreementacceptance-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['/agreements/{agreement-id}/acceptances'].get
  update:
    x-apievangelist-phrasing:
      intent: List who accepted a terms of use agreement
      effect: read
      questions:
      - Which users have accepted our terms of use agreement?
      - Can I filter agreement acceptances by user or state?
      instructions:
      - text: List acceptances of agreement {agreement_id}.
        slots:
          agreement_id: path.agreement-id
      - text: Show acceptances of agreement {agreement_id} matching {filter}.
        slots:
          agreement_id: path.agreement-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/acceptances'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an acceptance of an agreement
      effect: write
      questions:
      - How do I add an acceptance record to a terms of use agreement?
      - Can I capture the device and user details on a new acceptance?
      instructions:
      - text: Record that user {user_id} accepted agreement {agreement_id}.
        slots:
          agreement_id: path.agreement-id
          user_id: requestBody.userId
      - text: Create an acceptance on {agreement_id} for {user_email} from device {device_id}.
        slots:
          agreement_id: path.agreement-id
          user_email: requestBody.userEmail
          device_id: requestBody.deviceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one acceptance of an agreement
      effect: read
      questions:
      - When did a particular user accept the terms of use, and on which device?
      - Can I read a single acceptance record and see when it expires?
      instructions:
      - text: Show acceptance {acceptance_id} of agreement {agreement_id}.
        slots:
          agreement_id: path.agreement-id
          acceptance_id: path.agreementAcceptance-id
      - text: Get the state and expiration of acceptance {acceptance_id} on {agreement_id}.
        slots:
          agreement_id: path.agreement-id
          acceptance_id: path.agreementAcceptance-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agreement acceptance
      effect: destructive
      questions:
      - How do I remove an acceptance record from a terms of use agreement?
      - Can I delete an acceptance only if its etag still matches?
      instructions:
      - text: Delete acceptance {acceptance_id} from agreement {agreement_id}.
        slots:
          agreement_id: path.agreement-id
          acceptance_id: path.agreementAcceptance-id
      - text: Remove acceptance {acceptance_id} on {agreement_id} if the etag is {etag}.
        slots:
          agreement_id: path.agreement-id
          acceptance_id: path.agreementAcceptance-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an agreement acceptance
      effect: write
      questions:
      - How do I change the state of an existing agreement acceptance?
      - Can I set a new expiration date on an acceptance that's already recorded?
      instructions:
      - text: Set the state of acceptance {acceptance_id} on agreement {agreement_id} to {state}.
        slots:
          agreement_id: path.agreement-id
          acceptance_id: path.agreementAcceptance-id
          state: requestBody.state
      - text: Change acceptance {acceptance_id} of {agreement_id} to expire at {expires}.
        slots:
          agreement_id: path.agreement-id
          acceptance_id: path.agreementAcceptance-id
          expires: requestBody.expirationDateTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/acceptances/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count acceptances of an agreement
      effect: read
      questions:
      - How many people have accepted a terms of use agreement?
      - What number of acceptances on an agreement match a filter?
      instructions:
      - text: Count acceptances of agreement {agreement_id}.
        slots:
          agreement_id: path.agreement-id
      - text: Count acceptances on {agreement_id} matching {filter}.
        slots:
          agreement_id: path.agreement-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'