Skip to main content

Entitlementv2

Properties

NameTypeDescriptionNotes
IdStringThe entitlement id[optional]
NameStringThe entitlement name[optional]
AttributeStringThe entitlement attribute name[optional]
ValueStringThe value of the entitlement[optional]
SourceSchemaObjectTypeStringThe object type of the entitlement from the source schema[optional]
DescriptionStringThe description of the entitlement[optional]
PrivilegeLevelEntitlementv2PrivilegeLevel[optional]
Tags[]StringList of tags assigned to the entitlement[optional]
CloudGovernedBooleanTrue if the entitlement is cloud governed[optional] [default to $false]
RequestableBooleanTrue if the entitlement is able to be directly requested[optional] [default to $false]
OwnerEntitlementv2Owner[optional]
ManuallyUpdatedFields[map[string]AnyType]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated.[optional]
AccessModelMetadataEntitlementv2AccessModelMetadata[optional]
CreatedSystem.DateTimeTime when the entitlement was created[optional]
ModifiedSystem.DateTimeTime when the entitlement was last modified[optional]
SourceEntitlementv2Source[optional]
Attributes[map[string]AnyType]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4A map of free-form key-value pairs from the source system[optional]
Segments[]StringList of IDs of segments, if any, to which this Entitlement is assigned.[optional]
DirectPermissions[]Permissiondto[optional]

Examples

  • Prepare the resource
$Entitlementv2 = Initialize-Entitlementv2  -Id 2c91808874ff91550175097daaec161c `
-Name Account Payable `
-Attribute memberOf `
-Value CN=Account Payable,OU=Finance,DC=xyz company `
-SourceSchemaObjectType group `
-Description This entitlement allows users to access the accounts payable module of the organization's financial management system. Users can view, process, and approve invoices, manage vendor relationships, and perform other accounts payable-related tasks. `
-PrivilegeLevel null `
-Tags ["tag1","tag2"] `
-CloudGoverned true `
-Requestable true `
-Owner null `
-ManuallyUpdatedFields {"DISPLAY_NAME":true,"DESCRIPTION":true} `
-AccessModelMetadata null `
-Created 2020-10-08T18:33:52.029Z `
-Modified 2020-10-08T18:33:52.029Z `
-Source null `
-Attributes {"fieldName":"fieldValue"} `
-Segments ["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"] `
-DirectPermissions null
  • Convert the resource to JSON
$Entitlementv2 | ConvertTo-JSON

[Back to top]