Skip to main content

Role

Properties​

NameTypeDescriptionNotes
IdStringThe id for the Role[optional]
NameStringThe name of the Role[optional]
DescriptionStringInformation about the Role[optional]
PrivilegedBooleanDeprecated. Replaced by effectivePrivilege (HIGH, MEDIUM, LOW, NONE). Indicates if the role contains any access profiles that are privileged. Retained for backward compatibility.[optional] [default to $false]
OwnerIdentityReference[optional]
RevocableBooleanIndicates whether the Role can be revoked or requested[optional] [default to $false]
AssignmentIdStringthe ID of the role assignment[optional]
EndDateSystem.DateTimeThe date when a user's access expires.[optional]
Entitlements[]EntitlementReferenceA list of entitlement references associated to this Role.[optional]
AccessProfiles[]AccessProfileReferenceA list of access profile references associated to this Role.[optional]

Examples​

  • Prepare the resource
$Role = Initialize-Role -Id 2c91808a7190d06e0171993907fd0794 `
-Name Accounting-Employees `
-Description Role for members of the accounting department with the necessary Access Profiles `
-Privileged false `
-Owner null `
-Revocable false `
-AssignmentId 2c91808a7190d06e0171993907fd0794 `
-EndDate 2021-12-25T00:00Z `
-Entitlements null `
-AccessProfiles null
  • Convert the resource to JSON
$Role | ConvertTo-JSON

[Back to top]