developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-entitlement	Entitlement	Entitlement	Entitlement	powershellsdk	powershell PowerShell sdk Entitlement V2024Entitlement	/tools/sdk/powershell/v2024/models/entitlement	SDK Software Development Kit Entitlement V2024Entitlement

Entitlement

Properties

Name	Type	Description	Notes
Id	String	The entitlement id	[optional]
Name	String	The entitlement name	[optional]
Attribute	String	The entitlement attribute name	[optional]
Value	String	The value of the entitlement	[optional]
SourceSchemaObjectType	String	The object type of the entitlement from the source schema	[optional]
Description	String	The description of the entitlement	[optional]
Privileged	Boolean	True if the entitlement is privileged	[optional]
CloudGoverned	Boolean	True if the entitlement is cloud governed	[optional]
Requestable	Boolean	True if the entitlement is able to be directly requested	[optional] [default to $false]
Owner	EntitlementOwner		[optional]
ManuallyUpdatedFields	[map[string]AnyType]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4	A 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]
AccessModelMetadata	EntitlementAccessModelMetadata		[optional]
Created	System.DateTime	Time when the entitlement was created	[optional]
Modified	System.DateTime	Time when the entitlement was last modified	[optional]
Source	EntitlementSource		[optional]
Attributes	[map[string]AnyType]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4	A map of free-form key-value pairs from the source system	[optional]
Segments	[]String	List of IDs of segments, if any, to which this Entitlement is assigned.	[optional]
DirectPermissions	[]PermissionDto		[optional]

Examples

• Prepare the resource

$Entitlement = Initialize-V2024Entitlement  -Id 2c91808874ff91550175097daaec161c `
 -Name LauncherTest2 `
 -Attribute memberOf `
 -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
 -SourceSchemaObjectType group `
 -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
 -Privileged true `
 -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

$Entitlement | ConvertTo-JSON

[Back to top]