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.
# 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 Invitations.invitation API
version: 1.0.0
extends: openapi/azure-ad-invitations-invitation-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['/invitations'].get
update:
x-apievangelist-phrasing:
intent: List guest invitations
effect: read
questions:
- Which guest invitations has my tenant sent?
- Can I see the status of external user invites?
instructions:
- text: List all guest invitations.
- text: Show every invitation with its invited email and status.
method: generated
generated: '2026-10-01'
- target: $.paths['/invitations'].post
update:
x-apievangelist-phrasing:
intent: Invite an external guest user
effect: write
questions:
- How do I invite a partner to our tenant as a guest?
- Can I reset a guest's redemption status so they redeem the invite again?
- Is it possible to create an invite without sending the email?
instructions:
- text: Invite {email} as a guest and redirect them to {redirect_url} after redeeming.
slots:
email: requestBody.invitedUserEmailAddress
redirect_url: requestBody.inviteRedirectUrl
- text: Invite {email} with display name {name} and send the invitation email {send}.
slots:
email: requestBody.invitedUserEmailAddress
name: requestBody.invitedUserDisplayName
send: requestBody.sendInvitationMessage
- text: Reset the redemption status for guest {email} with a new invite to {redirect_url}.
slots:
email: requestBody.invitedUserEmailAddress
redirect_url: requestBody.inviteRedirectUrl
method: generated
generated: '2026-10-01'
- target: $.paths['/invitations/$count'].get
update:
x-apievangelist-phrasing:
intent: Count guest invitations
effect: read
questions:
- How many guest invitations exist?
- What's the total number of external invites on record?
instructions:
- text: Count the guest invitations.
- text: Tell me how many invitations have been created.
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.