group_lifecycle_policies

Creates, updates, deletes, gets or lists a group_lifecycle_policies resource.

Overview

Name	group_lifecycle_policies
Type	Resource
Id	entra_id.groups.group_lifecycle_policies

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
alternateNotificationEmails	string	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	number (int32)	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.
managedGroupTypes	string	The group type for which the expiration policy applies. Possible values are All, Selected or None.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
alternateNotificationEmails	string	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	number (int32)	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.
managedGroupTypes	string	The group type for which the expiration policy applies. Possible values are All, Selected or None.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group_id, group_lifecycle_policy_id		The collection of lifecycle policies for this group. Read-only. Nullable.
list	select	group_id		Retrieves a list of groupLifecyclePolicy objects to which a group belongs.
insert	insert	group_id
update	update	group_id, group_lifecycle_policy_id
delete	delete	group_id, group_lifecycle_policy_id	If-Match
add_group	exec	group_id, group_lifecycle_policy_id		Add a group to a groupLifecyclePolicy. This action is supported only if the managedGroupTypes property of the policy is set to Selected.
remove_group	exec	group_id, group_lifecycle_policy_id		Removes a group from a lifecycle policy.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
group_id	string	The unique identifier of group
group_lifecycle_policy_id	string	The unique identifier of groupLifecyclePolicy
If-Match	string	ETag

SELECT examples

get

The collection of lifecycle policies for this group. Read-only. Nullable.

SELECT
id,
alternateNotificationEmails,
groupLifetimeInDays,
managedGroupTypes
FROM entra_id.groups.group_lifecycle_policies
WHERE group_id = '{{ group_id }}' -- required
AND group_lifecycle_policy_id = '{{ group_lifecycle_policy_id }}' -- required
;

list

Retrieves a list of groupLifecyclePolicy objects to which a group belongs.

SELECT
id,
alternateNotificationEmails,
groupLifetimeInDays,
managedGroupTypes
FROM entra_id.groups.group_lifecycle_policies
WHERE group_id = '{{ group_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.groups.group_lifecycle_policies (
id,
alternateNotificationEmails,
groupLifetimeInDays,
managedGroupTypes,
group_id
)
SELECT 
'{{ id }}',
'{{ alternateNotificationEmails }}',
{{ groupLifetimeInDays }},
'{{ managedGroupTypes }}',
'{{ group_id }}'
RETURNING
id,
alternateNotificationEmails,
groupLifetimeInDays,
managedGroupTypes
;

Manifest

# Description fields are for documentation purposes
- name: group_lifecycle_policies
props:
  - name: group_id
    value: "{{ group_id }}"
    description: Required parameter for the group_lifecycle_policies resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: alternateNotificationEmails
    value: "{{ alternateNotificationEmails }}"
    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.
  - name: groupLifetimeInDays
    value: {{ groupLifetimeInDays }}
    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.
  - name: managedGroupTypes
    value: "{{ managedGroupTypes }}"
    description: |
      The group type for which the expiration policy applies. Possible values are All, Selected or None.

UPDATE examples

update

No description available.

UPDATE entra_id.groups.group_lifecycle_policies
SET 
id = '{{ id }}',
alternateNotificationEmails = '{{ alternateNotificationEmails }}',
groupLifetimeInDays = {{ groupLifetimeInDays }},
managedGroupTypes = '{{ managedGroupTypes }}'
WHERE 
group_id = '{{ group_id }}' --required
AND group_lifecycle_policy_id = '{{ group_lifecycle_policy_id }}' --required
RETURNING
id,
alternateNotificationEmails,
groupLifetimeInDays,
managedGroupTypes;

DELETE examples

delete

No description available.

DELETE FROM entra_id.groups.group_lifecycle_policies
WHERE group_id = '{{ group_id }}' --required
AND group_lifecycle_policy_id = '{{ group_lifecycle_policy_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

add_group

Add a group to a groupLifecyclePolicy. This action is supported only if the managedGroupTypes property of the policy is set to Selected.

EXEC entra_id.groups.group_lifecycle_policies.add_group 
@group_id='{{ group_id }}' --required, 
@group_lifecycle_policy_id='{{ group_lifecycle_policy_id }}' --required 
@@json=
'{
"groupId": "{{ groupId }}"
}'
;

remove_group

Removes a group from a lifecycle policy.

EXEC entra_id.groups.group_lifecycle_policies.remove_group 
@group_id='{{ group_id }}' --required, 
@group_lifecycle_policy_id='{{ group_lifecycle_policy_id }}' --required 
@@json=
'{
"groupId": "{{ groupId }}"
}'
;