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

API Evangelist conversational phrasing for Groups.group Setting API

7 actions 7 updates phrasing extends openapi/azure-ad-groups-groupsetting-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['/groups/{group-id}/settings'].get
$.paths['/groups/{group-id}/settings'].post
$.paths['/groups/{group-id}/settings/{groupSetting-id}'].get
$.paths['/groups/{group-id}/settings/{groupSetting-id}'].delete
$.paths['/groups/{group-id}/settings/{groupSetting-id}'].patch
$.paths['/groups/{group-id}/settings/$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 API
  version: 1.0.0
extends: openapi/azure-ad-groups-groupsetting-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['/groups/{group-id}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's settings
      effect: read
      questions:
      - What settings objects are configured on a particular Microsoft 365 group?
      - Can I see which setting templates a group's settings were built from?
      instructions:
      - text: List the settings on group {group}.
        slots:
          group: path.group-id
      - text: List settings for group {group} matching {filter}.
        slots:
          group: path.group-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a setting on a group from a template
      effect: write
      questions:
      - How do I apply a group setting template, like guest access, to one specific group?
      - Can I set values when creating a new setting on a group?
      instructions:
      - text: Create a setting on group {group} from template {templateId}.
        slots:
          group: path.group-id
          templateId: requestBody.templateId
      - text: Add a setting to group {group} using template {templateId} with values {values}.
        slots:
          group: path.group-id
          templateId: requestBody.templateId
          values: requestBody.values
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/settings/{groupSetting-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one setting on a group
      effect: read
      questions:
      - What values does a specific settings object on a group currently hold?
      - Which template is a given group setting based on?
      instructions:
      - text: Get setting {setting} on group {group}.
        slots:
          setting: path.groupSetting-id
          group: path.group-id
      - text: Show the values of group setting {setting} for group {group}.
        slots:
          setting: path.groupSetting-id
          group: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/settings/{groupSetting-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a setting from a group
      effect: destructive
      questions:
      - Can I remove a group-specific setting so the group falls back to tenant defaults?
      - How do I delete one settings object from a group?
      instructions:
      - text: Delete setting {setting} from group {group}.
        slots:
          setting: path.groupSetting-id
          group: path.group-id
      - text: Remove group setting {setting} on {group} if its ETag matches {etag}.
        slots:
          setting: path.groupSetting-id
          group: path.group-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/settings/{groupSetting-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change values of a group's setting
      effect: write
      questions:
      - How do I change a value, like allowing guests, in an existing group setting?
      - Can I rename a settings object on a group?
      instructions:
      - text: Update values of setting {setting} on group {group} to {values}.
        slots:
          setting: path.groupSetting-id
          group: path.group-id
          values: requestBody.values
      - text: Rename group setting {setting} on {group} to {displayName}.
        slots:
          setting: path.groupSetting-id
          group: path.group-id
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/settings/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a group's settings
      effect: read
      questions:
      - How many settings objects are applied to a particular group?
      - Can I count a group's settings matching a filter?
      instructions:
      - text: Count the settings on group {group}.
        slots:
          group: path.group-id
      - text: Count settings on group {group} that match {filter}.
        slots:
          group: path.group-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'