Microsoft Entra ID (formerly Azure AD)

Microsoft Entra ID (formerly Azure AD) Group Settings.group Setting API

The groupSettings.groupSetting API from Microsoft Entra ID (formerly Azure AD) — 3 operation(s) for groupsettings.groupsetting.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /groupSettings List group settings · List settings #
Ask an LLM
“Which tenant-wide and group-specific settings objects exist?”
“Can I filter the list of group settings?”
Tell an agent
List all group settings in the tenant.
Show group settings matching {filter}.
POST /groupSettings Create group settings from a template · Create settings #
Ask an LLM
“How do I create a tenant-wide group setting from a settings template?”
“Can I supply name-value pairs when creating a new group setting?”
Tell an agent
Create a group setting from template {template} with values {values}.
Create group setting {name} based on template {template}.
GET /groupSettings/{groupSetting-id} Get a group setting · Get groupSetting #
Ask an LLM
“How do I look up a single group setting by ID?”
“What values are stored in a specific group settings object?”
Tell an agent
Get group setting {setting}.
Show the values of group setting {setting}.
PATCH /groupSettings/{groupSetting-id} Update a group setting · Update groupSetting #
Ask an LLM
“How do I change the values of an existing group setting?”
“Can I rename a group settings object I already created?”
Tell an agent
Update group setting {setting} with values {values}.
Change the display name of group setting {setting} to {name}.
DELETE /groupSettings/{groupSetting-id} Delete a group setting · Delete a group setting #
Ask an LLM
“How do I delete a tenant-level or group-specific setting?”
“Can I delete a group setting only when its ETag matches?”
Tell an agent destructive · confirm first
Delete group setting {setting}.
Remove group setting {setting} if the ETag is {etag}.
GET /groupSettings/$count Count group settings · Get the number of the resource #
Ask an LLM
“How many group settings objects are there in the tenant?”
“Can I count group settings matching a filter?”
Tell an agent
Count the group settings in the tenant.
Count group settings matching {filter}.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/graph/api/overview
📖
Authentication
https://learn.microsoft.com/en-us/graph/auth/
📖
Documentation
https://learn.microsoft.com/en-us/graph/change-notifications-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/openapi/azure-ad-groupsettings-groupsetting-api-openapi.yml

Other Resources

🔗
SDKs
https://learn.microsoft.com/en-us/graph/sdks/sdks-overview
🔗
ChangeLog
https://developer.microsoft.com/en-us/graph/changelog
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/asyncapi/azure-ad-change-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/azure-ad:azure-ad-groupsettings-groupsetting-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-ad-groupsettings-groupsetting-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Groups Group Settings.group Setting API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: groupSettings.groupSetting
paths:
  /groupSettings:
    get:
      tags:
      - groupSettings.groupSetting
      summary: List settings
      description: Retrieve a list of tenant-level or group-specific group settings objects.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/group-list-settings?view=graph-rest-1.0
      operationId: groupSetting_ListGroupSetting
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.groupSettingCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - groupSettings.groupSetting
      summary: Create settings
      description: 'Create a new group setting based on the templates available in groupSettingTemplates. These settings can be at the tenant-level or at the group level. The following group setting templates are available for groups:'
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/group-post-settings?view=graph-rest-1.0
      operationId: groupSetting_CreateGroupSetting
      requestBody:
        description: New entity
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.groupSetting'
        required: true
      responses:
        2XX:
          description: Created entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.groupSetting'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /groupSettings/{groupSetting-id}:
    get:
      tags:
      - groupSettings.groupSetting
      summary: Get groupSetting
      description: Retrieve the properties of a specific group setting object. The setting can be a tenant-level or group-specific setting.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/groupsetting-get?view=graph-rest-1.0
      operationId: groupSetting_GetGroupSetting
      parameters:
      - name: groupSetting-id
        in: path
        description: The unique identifier of groupSetting
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: groupSetting
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.groupSetting'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - groupSettings.groupSetting
      summary: Update groupSetting
      description: Update the properties of a groupSetting object for tenant-wide group settings or a specific group setting.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/groupsetting-update?view=graph-rest-1.0
      operationId: groupSetting_UpdateGroupSetting
      parameters:
      - name: groupSetting-id
        in: path
        description: The unique identifier of groupSetting
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: groupSetting
      requestBody:
        description: New property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.groupSetting'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.groupSetting'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - groupSettings.groupSetting
      summary: Delete a group setting
      description: Delete a tenant-level or group-specific groupSetting object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/groupsetting-delete?view=graph-rest-1.0
      operationId: groupSetting_DeleteGroupSetting
      parameters:
      - name: groupSetting-id
        in: path
        description: The unique identifier of groupSetting
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: groupSetting
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /groupSettings/$count:
    get:
      tags:
      - groupSettings.groupSetting
      summary: Get the number of the resource
      operationId: groupSetting_GetCount
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
    microsoft.graph.groupSettingCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.groupSettingCollectionResponse'
  schemas:
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.groupSetting:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: groupSetting
        type: object
        properties:
          displayName:
            type:
            - string
            - 'null'
            description: Display name of this group of settings, which comes from the associated template.
          templateId:
            type:
            - string
            - 'null'
            description: Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
          values:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.settingValue'
            description: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.
        additionalProperties:
          type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.settingValue:
      title: settingValue
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the setting (as defined by the groupSettingTemplate).
        value:
          type:
          - string
          - 'null'
          description: Value of the setting.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.groupSettingCollectionResponse:
      title: Collection of groupSetting
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.groupSetting'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
  parameters:
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}