Skip to main content

RoleDocument

Properties

NameTypeDescriptionNotes
DescriptionStringAccess item's description.[optional]
CreatedSystem.DateTimeISO-8601 date-time referring to the time when the object was created.[optional]
ModifiedSystem.DateTimeISO-8601 date-time referring to the time when the object was last modified.[optional]
SyncedSystem.DateTimeISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the synced time and the time when the updated data is actually available in the search API.[optional]
EnabledBooleanIndicates whether the access item is currently enabled.[optional] [default to $false]
RequestableBooleanIndicates whether the access item can be requested.[optional] [default to $true]
RequestCommentsRequiredBooleanIndicates whether comments are required for requests to access the item.[optional] [default to $false]
OwnerBaseAccessOwner[optional]
IdStringID of the role.[required]
NameStringName of the role.[required]
AccessProfiles[]BaseAccessProfileAccess profiles included with the role.[optional]
AccessProfileCountInt32Number of access profiles included with the role.[optional]
Tags[]StringTags that have been applied to the object.[optional]
Segments[]BaseSegmentSegments with the role.[optional]
SegmentCountInt32Number of segments with the role.[optional]
Entitlements[]RoleDocumentAllOfEntitlementsEntitlements included with the role.[optional]
EntitlementCountInt32Number of entitlements included with the role.[optional]
DimensionalBoolean[optional] [default to $false]
DimensionSchemaAttributeCountInt32Number of dimension attributes included with the role.[optional]
DimensionSchemaAttributes[]RoleDocumentAllOfDimensionSchemaAttributesDimension attributes included with the role.[optional]
Dimensions[]RoleDocumentAllOfDimensions[optional]

Examples

  • Prepare the resource
$RoleDocument = Initialize-PSSailpoint.V3RoleDocument  -Description Admin access `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Synced 2018-06-25T20:22:33.104Z `
-Enabled true `
-Requestable true `
-RequestCommentsRequired false `
-Owner null `
-Id 2c91808375d8e80a0175e1f88a575222 `
-Name Branch Manager Access `
-AccessProfiles null `
-AccessProfileCount 1 `
-Tags [TAG_1, TAG_2] `
-Segments null `
-SegmentCount 1 `
-Entitlements null `
-EntitlementCount 3 `
-Dimensional false `
-DimensionSchemaAttributeCount 3 `
-DimensionSchemaAttributes null `
-Dimensions null
  • Convert the resource to JSON
$RoleDocument | ConvertTo-JSON

[Back to top]