Skip to main content

Role

Properties​

NameTypeDescriptionNotes
id(optional) stringThe id for the Role[default to undefined]
name(optional) stringThe name of the Role[default to undefined]
description(optional) stringInformation about the Role[default to undefined]
privileged(optional) booleanDeprecated. Replaced by effectivePrivilege (HIGH, MEDIUM, LOW, NONE). Indicates if the role contains any access profiles that are privileged. Retained for backward compatibility.[default to false]
owner(optional) IdentityReference[default to undefined]
revocable(optional) booleanIndicates whether the Role can be revoked or requested[default to false]
assignmentId(optional) stringthe ID of the role assignment[default to undefined]
endDate(optional) stringThe date when a user's access expires.[default to undefined]
entitlements(optional) Array<EntitlementReference>A list of entitlement references associated to this Role.[default to undefined]
accessProfiles(optional) Array<AccessProfileReference>A list of access profile references associated to this Role.[default to undefined]