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

API Evangelist conversational phrasing for Groups Group Setting Templates.group Setting Template API

7 actions 7 updates phrasing extends openapi/azure-ad-groupsettingtemplates-groupsettingtemplate-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['/groupSettingTemplates'].get
$.paths['/groupSettingTemplates'].post
$.paths['/groupSettingTemplates/{groupSettingTemplate-id}'].get
$.paths['/groupSettingTemplates/{groupSettingTemplate-id}'].delete
$.paths['/groupSettingTemplates/{groupSettingTemplate-id}'].patch
$.paths['/groupSettingTemplates/$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 Groups Group Setting Templates.group Setting Template API
  version: 1.0.0
extends: openapi/azure-ad-groupsettingtemplates-groupsettingtemplate-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['/groupSettingTemplates'].get
  update:
    x-apievangelist-phrasing:
      intent: List available group setting templates
      effect: read
      questions:
      - Which group setting templates are available in my tenant, like Group.Unified?
      - How do I find the template ID I need before creating tenant group settings?
      instructions:
      - text: List all group setting templates in the tenant.
      - text: Show group setting templates filtered by {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettingTemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a group setting template
      effect: write
      questions:
      - Can I add a new entity to the group setting templates collection?
      - What name, description and values does a group setting template take?
      instructions:
      - text: Create a group setting template named {display_name} with values {values}.
        slots:
          display_name: requestBody.displayName
          values: requestBody.values
      - text: Add a group setting template described as {description}.
        slots:
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettingTemplates/{groupSettingTemplate-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group setting template's defaults
      effect: read
      questions:
      - What default values and setting names does a particular group setting template define?
      - Can I read one group setting template by its ID?
      instructions:
      - text: Get group setting template {template_id}.
        slots:
          template_id: path.groupSettingTemplate-id
      - text: Show the settings and defaults defined by template {template_id}.
        slots:
          template_id: path.groupSettingTemplate-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettingTemplates/{groupSettingTemplate-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group setting template
      effect: destructive
      questions:
      - Can I delete a group setting template from the tenant?
      - Is removing a group setting template reversible?
      instructions:
      - text: Delete group setting template {template_id}.
        slots:
          template_id: path.groupSettingTemplate-id
      - text: Remove template {template_id} from group setting templates, matching ETag {etag}.
        slots:
          template_id: path.groupSettingTemplate-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettingTemplates/{groupSettingTemplate-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group setting template
      effect: write
      questions:
      - Can I rename or change the default values of a group setting template?
      - Which properties of a group setting template can be patched?
      instructions:
      - text: Rename group setting template {template_id} to {display_name}.
        slots:
          template_id: path.groupSettingTemplate-id
          display_name: requestBody.displayName
      - text: Update the values of template {template_id} to {values}.
        slots:
          template_id: path.groupSettingTemplate-id
          values: requestBody.values
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettingTemplates/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count group setting templates
      effect: read
      questions:
      - How many group setting templates exist in the tenant?
      - What's the total number of templates matching a search term?
      instructions:
      - text: Count the group setting templates in the tenant.
      - text: Return how many group setting templates match {search}.
        slots:
          search: query.$search
      method: generated
      generated: '2026-10-01'