Microsoft Graph Groups is the Microsoft Graph API surface for managing Azure AD and Microsoft 365 groups and everything connected to them. It lets you create, read, update, and delete groups; add or remove owners and members (including dynamic membership rules); query transitive membership and changes via delta; and manage group settings and lifecycle policies such as expiration.
openapi: 3.1.0
info:
title: Microsoft Graph Groups
description: Needs a description.
paths:
/connections/{externalConnection-id}/groups:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get groups from connections
operationId: connections.ListGroups
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.externalConnectors.externalGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- connections.externalGroup
summary: Microsoft Graph Create new navigation property to groups for connections
operationId: connections.CreateGroups
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/connections/{externalConnection-id}/groups/{externalGroup-id}:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get groups from connections
operationId: connections.GetGroups
parameters:
- 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 navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- connections.externalGroup
summary: Microsoft Graph Update the navigation property groups in connections
operationId: connections.UpdateGroups
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- connections.externalGroup
summary: Microsoft Graph Delete navigation property groups for connections
operationId: connections.DeleteGroups
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/connections/{externalConnection-id}/groups/{externalGroup-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.externalConnectors.externalGroup entity.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get members from connections
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: connections.groups.ListMembers
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.externalConnectors.identityCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- connections.externalGroup
summary: Microsoft Graph Create new navigation property to members for connections
operationId: connections.groups.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalConnectors.identity'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/connections/{externalConnection-id}/groups/{externalGroup-id}/members/{identity-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.externalConnectors.externalGroup entity.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get members from connections
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: connections.groups.GetMembers
parameters:
- 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 navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- connections.externalGroup
summary: Microsoft Graph Update the navigation property members in connections
operationId: connections.groups.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalConnectors.identity'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- connections.externalGroup
summary: Microsoft Graph Delete navigation property members for connections
operationId: connections.groups.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
- name: identity-id
in: path
description: The unique identifier of identity
required: true
schema:
type: string
x-ms-docs-key-type: identity
/connections/{externalConnection-id}/groups/{externalGroup-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get the number of the resource
operationId: connections.groups.members.GetCount-d49a
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/connections/{externalConnection-id}/groups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- connections.externalGroup
summary: Microsoft Graph Get the number of the resource
operationId: connections.groups.GetCount-6035
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/external/connections/{externalConnection-id}/groups:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get externalGroup
description: Get an externalGroup object.
operationId: external.connections.ListGroups
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.externalConnectors.externalGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- external.externalConnection
summary: Microsoft Graph Create externalGroup
description: Create a new externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-post-groups?view=graph-rest-1.0
operationId: external.connections.CreateGroups
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/external/connections/{externalConnection-id}/groups/{externalGroup-id}:
description: >-
Provides operations to manage the groups property of the
microsoft.graph.externalConnectors.externalConnection entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get externalGroup
description: Get an externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-get?view=graph-rest-1.0
operationId: external.connections.GetGroups
parameters:
- 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 navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- external.externalConnection
summary: Microsoft Graph Update externalGroup
description: Update the properties of an externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-update?view=graph-rest-1.0
operationId: external.connections.UpdateGroups
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- external.externalConnection
summary: Microsoft Graph Delete externalGroup
description: Delete an externalGroup object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-delete?view=graph-rest-1.0
operationId: external.connections.DeleteGroups
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/external/connections/{externalConnection-id}/groups/{externalGroup-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.externalConnectors.externalGroup entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get members from external
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: external.connections.groups.ListMembers
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.externalConnectors.identityCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- external.externalConnection
summary: Microsoft Graph Create identity
description: Create an identity resource for a new member in an externalGroup.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroup-post-members?view=graph-rest-1.0
operationId: external.connections.groups.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalConnectors.identity'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/external/connections/{externalConnection-id}/groups/{externalGroup-id}/members/{identity-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.externalConnectors.externalGroup entity.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get members from external
description: >-
A member added to an externalGroup. You can add Microsoft Entra users,
Microsoft Entra groups, or an externalGroup as members.
operationId: external.connections.groups.GetMembers
parameters:
- 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 navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- external.externalConnection
summary: Microsoft Graph Update the navigation property members in external
operationId: external.connections.groups.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalConnectors.identity'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.externalConnectors.identity
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- external.externalConnection
summary: Microsoft Graph Delete identity
description: >-
Delete an identity resource to remove the corresponding member from an
externalGroup.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/externalconnectors-externalgroupmember-delete?view=graph-rest-1.0
operationId: external.connections.groups.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
- name: identity-id
in: path
description: The unique identifier of identity
required: true
schema:
type: string
x-ms-docs-key-type: identity
/external/connections/{externalConnection-id}/groups/{externalGroup-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get the number of the resource
operationId: external.connections.groups.members.GetCount-482b
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
- name: externalGroup-id
in: path
description: The unique identifier of externalGroup
required: true
schema:
type: string
x-ms-docs-key-type: externalGroup
/external/connections/{externalConnection-id}/groups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- external.externalConnection
summary: Microsoft Graph Get the number of the resource
operationId: external.connections.groups.GetCount-51f5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: externalConnection-id
in: path
description: The unique identifier of externalConnection
required: true
schema:
type: string
x-ms-docs-key-type: externalConnection
/groups:
description: Provides operations to manage the collection of group entities.
get:
tags:
- Groups.group
summary: Microsoft Graph List groups
description: >-
List all the groups available in an organization, excluding dynamic
distribution groups. To retrieve dynamic distribution groups, use the
Exchange admin center. This operation returns by default only a subset
of the properties for each group. These default properties are noted in
the Properties section. To get properties that are not returned by
default, do a GET operation for the group and specify the properties in
a $select OData query option. The hasMembersWithLicenseErrors and
isArchived properties are an exception and are not returned in the
$select query.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-list?view=graph-rest-1.0
operationId: groups.group.ListGroup
parameters:
-
# --- truncated at 32 KB (4733 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/groups-openapi-original.yml