Microsoft Entra ID (formerly Azure AD) Groups.group Lifecycle Policy API
The groups.groupLifecyclePolicy API from Microsoft Entra ID (formerly Azure AD) — 5 operation(s) for groups.grouplifecyclepolicy.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/azure-ad-groups-grouplifecyclepolicy-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Groups.group Lifecycle Policy API
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
security:
- azureaadv2: []
tags:
- name: groups.groupLifecyclePolicy
paths:
/groups/{group-id}/groupLifecyclePolicies:
get:
tags:
- groups.groupLifecyclePolicy
summary: List groupLifecyclePolicies
description: Retrieves a list of groupLifecyclePolicy objects to which a group belongs.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-list-grouplifecyclepolicies?view=graph-rest-1.0
operationId: group_ListGroupLifecyclePolicy
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $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.groupLifecyclePolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.groupLifecyclePolicy
summary: Create new navigation property to groupLifecyclePolicies for groups
operationId: group_CreateGroupLifecyclePolicy
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/groups/{group-id}/groupLifecyclePolicies/{groupLifecyclePolicy-id}:
get:
tags:
- groups.groupLifecyclePolicy
summary: Get groupLifecyclePolicies from groups
description: The collection of lifecycle policies for this group. Read-only. Nullable.
operationId: group_GetGroupLifecyclePolicy
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: groupLifecyclePolicy-id
in: path
description: The unique identifier of groupLifecyclePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: groupLifecyclePolicy
- 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.groupLifecyclePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.groupLifecyclePolicy
summary: Update the navigation property groupLifecyclePolicies in groups
operationId: group_UpdateGroupLifecyclePolicy
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: groupLifecyclePolicy-id
in: path
description: The unique identifier of groupLifecyclePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: groupLifecyclePolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.groupLifecyclePolicy
summary: Delete navigation property groupLifecyclePolicies for groups
operationId: group_DeleteGroupLifecyclePolicy
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: groupLifecyclePolicy-id
in: path
description: The unique identifier of groupLifecyclePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: groupLifecyclePolicy
- 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
/groups/{group-id}/groupLifecyclePolicies/{groupLifecyclePolicy-id}/microsoft.graph.addGroup:
post:
tags:
- groups.groupLifecyclePolicy
summary: Invoke action addGroup
description: Add a group to a groupLifecyclePolicy. This action is supported only if the managedGroupTypes property of the policy is set to Selected.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/grouplifecyclepolicy-addgroup?view=graph-rest-1.0
operationId: group.groupLifecyclePolicy_addGroup
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: groupLifecyclePolicy-id
in: path
description: The unique identifier of groupLifecyclePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: groupLifecyclePolicy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: boolean
default: false
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/groupLifecyclePolicies/{groupLifecyclePolicy-id}/microsoft.graph.removeGroup:
post:
tags:
- groups.groupLifecyclePolicy
summary: Invoke action removeGroup
description: Removes a group from a lifecycle policy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/grouplifecyclepolicy-removegroup?view=graph-rest-1.0
operationId: group.groupLifecyclePolicy_removeGroup
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: groupLifecyclePolicy-id
in: path
description: The unique identifier of groupLifecyclePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: groupLifecyclePolicy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: boolean
default: false
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/groups/{group-id}/groupLifecyclePolicies/$count:
get:
tags:
- groups.groupLifecyclePolicy
summary: Get the number of the resource
operationId: group.groupLifecyclePolicy_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $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'
microsoft.graph.groupLifecyclePolicyCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicyCollectionResponse'
ODataCountResponse:
description: The count of the resource
content:
text/plain:
schema:
$ref: '#/components/schemas/ODataCountResponse'
schemas:
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
ODataCountResponse:
type: integer
format: int32
microsoft.graph.ODataErrors.ODataError:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
additionalProperties:
type: object
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.groupLifecyclePolicyCollectionResponse:
title: Collection of groupLifecyclePolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
'@odata.nextLink':
type:
- string
- 'null'
additionalProperties:
type: object
microsoft.graph.ODataErrors.InnerError:
type: object
additionalProperties:
type: object
description: The structure of this object is service-specific
microsoft.graph.groupLifecyclePolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupLifecyclePolicy
type: object
properties:
alternateNotificationEmails:
type:
- string
- 'null'
description: List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
groupLifetimeInDays:
maximum: 2147483647
minimum: -2147483648
type:
- number
- 'null'
description: Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.
format: int32
managedGroupTypes:
type:
- string
- 'null'
description: The group type for which the expiration policy applies. Possible values are All, Selected or None.
additionalProperties:
type: object
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
filter:
name: $filter
in: query
description: Filter items by property values
style: form
explode: false
schema:
type: string
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
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: {}