Retrieve permissions script
When the Use Script To Retrieve Permissions toggle is enabled, the Retrieve Permissions Script defines the Standard permissions in a permission set.
Use this script if you're creating a large number (~>10) of standard permissions, or if you don't know them in advance and need to make API calls into the target system to retrieve them. Otherwise, it's easier to disable the Use Script To Retrieve Permissions toggle and define your standard permissions manually.
Each permission must be defined as a hash table with the following properties:
@{
DisplayName = "First permission"
Identification = @{
Reference = "Permission1"
}
}- DisplayName
A string that identifies the Permission entitlements produced by the permission set.
- Identification
A hash table that has one property,
Reference.- Reference
A string that uniquely identifies the permission. HelloID subsequently passes these values into the Permission actions script(s) via $actionContext.References.Permission.
You should add hash table objects to $outputContext.Permissions using the Add method.
When permissions are retrieved
Retrieved permissions are cached in Target snapshots.
The Retrieve permissions script runs in the following situations if the cache is more than 24 hours old:
During an Enforcement. It can run on a schedule or be started manually.
When you Import target system entitlements for an Import entitlements report.
When you Create a reconciliation report.
The script always runs and retrieves the current permissions when you click the Sync button on the Entitlements tab of a business rule.
Note
The Retrieve permissions script must complete within 15 minutes.