entitlement_management_settings
Creates, updates, deletes, gets or lists an entitlement_management_settings resource.
Overview
| Name | entitlement_management_settings |
| Type | Resource |
| Id | entra_id.identity_governance.entitlement_management_settings |
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. |
durationUntilExternalUserDeletedAfterBlocked | string (duration) | If externalUserLifecycleAction is blockSignInAndDelete, the duration, typically many days, after an external user is blocked from sign in before their account is deleted. (pattern: ^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$) |
externalUserLifecycleAction | | Automatic action that the service should take when an external user's last access package assignment is removed. The possible values are: none, blockSignIn, blockSignInAndDelete, unknownFutureValue. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Retrieve the properties of an entitlementManagementSettings object. | ||
update | update | Update an existing entitlementManagementSettings object to change one or more of its properties. | ||
delete | delete | If-Match |
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 |
|---|---|---|
If-Match | string | ETag |
SELECT examples
- get
Retrieve the properties of an entitlementManagementSettings object.
SELECT
id,
durationUntilExternalUserDeletedAfterBlocked,
externalUserLifecycleAction
FROM entra_id.identity_governance.entitlement_management_settings
;
UPDATE examples
- update
Update an existing entitlementManagementSettings object to change one or more of its properties.
UPDATE entra_id.identity_governance.entitlement_management_settings
SET
id = '{{ id }}',
durationUntilExternalUserDeletedAfterBlocked = '{{ durationUntilExternalUserDeletedAfterBlocked }}',
externalUserLifecycleAction = '{{ externalUserLifecycleAction }}'
RETURNING
id,
durationUntilExternalUserDeletedAfterBlocked,
externalUserLifecycleAction;
DELETE examples
- delete
No description available.
DELETE FROM entra_id.identity_governance.entitlement_management_settings
WHERE If-Match = '{{ If-Match }}'
;