openapi: 3.1.0
info:
title: Microsoft Graph Admin Admin.admin groups.group.Actions API
description: 'Microsoft Graph API for managing administrative resources in Microsoft Entra ID.
This API enables administrators to manage Microsoft Edge browser settings, Internet Explorer mode configurations,
site lists, shared browser sites, Microsoft 365 Apps installation options, people insights, service announcements,
SharePoint settings, Copilot administration, directory administrative units, and admin consent policies.'
version: 1.0.0
contact:
name: Microsoft Graph API Support
url: https://developer.microsoft.com/graph
servers:
- url: https://graph.microsoft.com/v1.0
description: Microsoft Graph API v1.0 endpoint
tags:
- name: groups.group.Actions
paths:
/groups/{group-id}/addFavorite:
description: Provides operations to call the addFavorite method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action addFavorite
description: Add the group to the list of the current user's favorite groups. The group shows up in Outlook and Teams favorites. Supported for Microsoft 365 groups only.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-addfavorite?view=graph-rest-1.0
operationId: groups.group.addFavorite
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/assignLicense:
description: Provides operations to call the assignLicense method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action assignLicense
description: Add or remove licenses on a group. Licenses assigned to the group will be assigned to all users in the group. Group-based licensing is an alternative to direct user licensing. To learn more about group-based licensing, see What is group-based licensing in Microsoft Entra ID. To get the subscriptions available in the directory, perform a GET subscribedSkus request.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-assignlicense?view=graph-rest-1.0
operationId: groups.group.assignLicense
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
addLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
removeLicenses:
type: array
items:
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
format: uuid
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.group'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/checkGrantedPermissionsForApp:
description: Provides operations to call the checkGrantedPermissionsForApp method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action checkGrantedPermissionsForApp
operationId: groups.group.checkGrantedPermissionsForApp
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of resourceSpecificPermissionGrant
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/groups/{group-id}/checkMemberGroups:
description: Provides operations to call the checkMemberGroups method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action checkMemberGroups
description: "Check for membership in a specified list of group IDs, and return from that list the IDs of groups where a specified object is a member. The specified object can be of one of the following types:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-checkmembergroups?view=graph-rest-1.0
operationId: groups.group.checkMemberGroups
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupIds:
type: array
items:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/groups/{group-id}/checkMemberObjects:
description: Provides operations to call the checkMemberObjects method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action checkMemberObjects
operationId: groups.group.checkMemberObjects
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/groups/{group-id}/getMemberGroups:
description: Provides operations to call the getMemberGroups method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action getMemberGroups
description: Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmembergroups?view=graph-rest-1.0
operationId: groups.group.getMemberGroups
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/groups/{group-id}/getMemberObjects:
description: Provides operations to call the getMemberObjects method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action getMemberObjects
description: "Return all IDs for the groups, administrative units, and directory roles that an object of one of the following types is a member of:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. Only users and role-enabled groups can be members of directory roles."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmemberobjects?view=graph-rest-1.0
operationId: groups.group.getMemberObjects
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/groups/{group-id}/removeFavorite:
description: Provides operations to call the removeFavorite method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action removeFavorite
description: Remove the group from the list of the current user's favorite groups. Supported for Microsoft 365 groups only.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-removefavorite?view=graph-rest-1.0
operationId: groups.group.removeFavorite
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/renew:
description: Provides operations to call the renew method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action renew
description: Renew a group's expiration. When a group is renewed, the group expiration is extended by the number of days defined in the policy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-renew?view=graph-rest-1.0
operationId: groups.group.renew
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/resetUnseenCount:
description: Provides operations to call the resetUnseenCount method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action resetUnseenCount
description: Reset the unseenCount of all the posts that the current user hasn't seen since their last visit. Supported for Microsoft 365 groups only.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-resetunseencount?view=graph-rest-1.0
operationId: groups.group.resetUnseenCount
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/restore:
description: Provides operations to call the restore method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
x-ms-docs-grouped-path:
- /groups/{group-id}/sites/{site-id}/lists/{list-id}/items/{listItem-id}/documentSetVersions/{documentSetVersion-id}/restore
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action restore
description: "Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. Restore a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user If an item is accidentally deleted, you can fully restore the item. Additionally, restoring an application doesn't automatically restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directory-deleteditems-restore?view=graph-rest-1.0
operationId: groups.group.restore
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/retryServiceProvisioning:
description: Provides operations to call the retryServiceProvisioning method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action retryServiceProvisioning
description: Retry the group service provisioning.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-retryserviceprovisioning?view=graph-rest-1.0
operationId: groups.group.retryServiceProvisioning
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/subscribeByMail:
description: Provides operations to call the subscribeByMail method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action subscribeByMail
description: Calling this method will enable the current user to receive email notifications for this group, about new posts, events, and files in that group. Supported for Microsoft 365 groups only.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-subscribebymail?view=graph-rest-1.0
operationId: groups.group.subscribeByMail
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/unsubscribeByMail:
description: Provides operations to call the unsubscribeByMail method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action unsubscribeByMail
description: Calling this method prevents the current user from receiving email notifications for this group about new posts, events, and files in that group. Supported for Microsoft 365 groups only.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-unsubscribebymail?view=graph-rest-1.0
operationId: groups.group.unsubscribeByMail
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/validateProperties:
description: Provides operations to call the validateProperties method.
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
x-ms-docs-grouped-path:
- /groups/validateProperties
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action validateProperties
description: 'Validate that a Microsoft 365 group''s display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to update a Microsoft 365 group. To validate the properties before creating a group, use the directoryobject:validateProperties function. The following policy validations are performed for the display name and mail nickname properties: This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-validateproperties?view=graph-rest-1.0
operationId: groups.group.validateProperties
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
displayName:
type: string
nullable: true
mailNickname:
type: string
nullable: true
onBehalfOfUserId:
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
format: uuid
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/getAvailableExtensionProperties:
description: Provides operations to call the getAvailableExtensionProperties method.
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action getAvailableExtensionProperties
description: 'Return all directory extension definitions that are registered in a directory, including through multitenant apps. The following entities support extension properties:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0
operationId: groups.getAvailableExtensionProperties
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isSyncedFromOnPremises:
type: boolean
default: false
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of extensionProperty
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/groups/getByIds:
description: Provides operations to call the getByIds method.
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action getByIds
description: 'Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0
operationId: groups.getByIds
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
types:
type: array
items:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of directoryObject
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/groups/validateProperties:
description: Provides operations to call the validateProperties method.
x-ms-docs-grouped-path:
- /groups/{group-id}/validateProperties
post:
tags:
- groups.group.Actions
summary: Microsoft Graph Invoke action validateProperties
description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\r\n1. Validate the prefix and suffix naming policy\r\n2. Validate the custom banned words policy\r\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you're only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0
operationId: groups.validateProperties
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
entityType:
type: string
nullable: true
displayName:
type: string
nullable: true
mailNickname:
type: string
nullable: true
onBehalfOfUserId:
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
format: uuid
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
components:
schemas:
microsoft.graph.richLongRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- title: richLongRunningOperation
required:
- '@odata.type'
type: object
properties:
error:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.publicError'
- type: object
nullable: true
description: Error that caused the operation to fail.
percentageComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: A value between 0 and 100 that indicates the progress of the operation.
format: int32
nullable: true
resourceId:
type: string
description: The unique identifier for the result.
nullable: true
type:
type: string
description: The type of the operation.
nullable: true
'@odata.type':
type: string
description: The status of a long-running operation.
x-ms-discriminator-value: '#microsoft.graph.richLongRunningOperation'
microsoft.graph.workbookWorksheet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookWorksheet
required:
- '@odata.type'
type: object
properties:
name:
type: string
description: The display name of the worksheet.
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: number
description: The zero-based position of the worksheet within the workbook.
format: int32
visibility:
type: string
description: 'The visibility of the worksheet. The possible values are: Visible, Hidden, VeryHidden.'
charts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChart'
description: The list of charts that are part of the worksheet. Read-only.
x-ms-navigationProperty: true
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: The list of names that are associated with the worksheet. Read-only.
x-ms-navigationProperty: true
pivotTables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookPivotTable'
description: The list of piot tables that are part of the worksheet.
x-ms-navigationProperty: true
protection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheetProtection'
- type: object
nullable: true
description: The sheet protection object for a worksheet. Read-only.
x-ms-navigationProperty: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable
# --- truncated at 32 KB (1022 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/microsoft-graph-groups-group-actions-api-openapi.yml