Skip to main content

ownerless_group_policy

Creates, updates, deletes, gets or lists an ownerless_group_policy resource.

Overview

Nameownerless_group_policy
TypeResource
Identra_id.policies.ownerless_group_policy

Fields

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringThe unique identifier for an entity. Read-only.
emailInfoobject (title: emailDetails)
enabledGroupIdsarrayThe collection of IDs for groups to which the policy is enabled. If empty, the policy is enabled for all groups in the tenant.
isEnabledbooleanIndicates whether the ownerless group policy is enabled in the tenant. Setting this property to false clears the values of all other policy parameters.
maxMembersToNotifynumber (int64)The maximum number of members to notify. Value range is 0-90. Members are prioritized by recent group activity (most active first). If there aren't enough active members to fill the limit, remaining slots are filled with other eligible group members from the directory.
notificationDurationInWeeksnumber (int64)The number of weeks for the notification duration. Value range is 1-7.
policyWebUrlstringThe URL to the policy documentation.
targetOwnersobject (title: targetOwners)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectRead the properties of an ownerlessGroupPolicy object.
updateupdateCreate or update the ownerlessGroupPolicy for the tenant. If the policy doesn't exist, it creates a new one; if the policy exists, it updates the existing policy. To disable the policy, set isEnabled to false. Setting isEnabled to false clears the values of all other policy parameters.

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.

NameDatatypeDescription

SELECT examples

Read the properties of an ownerlessGroupPolicy object.

SELECT
id,
emailInfo,
enabledGroupIds,
isEnabled,
maxMembersToNotify,
notificationDurationInWeeks,
policyWebUrl,
targetOwners
FROM entra_id.policies.ownerless_group_policy
;

UPDATE examples

Create or update the ownerlessGroupPolicy for the tenant. If the policy doesn't exist, it creates a new one; if the policy exists, it updates the existing policy. To disable the policy, set isEnabled to false. Setting isEnabled to false clears the values of all other policy parameters.

UPDATE entra_id.policies.ownerless_group_policy
SET
id = '{{ id }}',
emailInfo = '{{ emailInfo }}',
enabledGroupIds = '{{ enabledGroupIds }}',
isEnabled = {{ isEnabled }},
maxMembersToNotify = {{ maxMembersToNotify }},
notificationDurationInWeeks = {{ notificationDurationInWeeks }},
policyWebUrl = '{{ policyWebUrl }}',
targetOwners = '{{ targetOwners }}'
RETURNING
id,
emailInfo,
enabledGroupIds,
isEnabled,
maxMembersToNotify,
notificationDurationInWeeks,
policyWebUrl,
targetOwners;