Skip to main content

Role

Properties

NameTypeDescriptionNotes
id(optional) stringThe id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.[default to undefined]
namestringThe human-readable display name of the Role[default to undefined]
created(optional) stringDate the Role was created[readonly] [default to undefined]
modified(optional) stringDate the Role was last modified.[readonly] [default to undefined]
description(optional) stringA human-readable description of the Role[default to undefined]
ownerOwnerreference[default to undefined]
additionalOwners(optional) Array<Additionalownerref>List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).[default to undefined]
accessProfiles(optional) Array<Accessprofileref>[default to undefined]
entitlements(optional) Array<Entitlementref>[default to undefined]
membership(optional) Rolemembershipselector[default to undefined]
legacyMembershipInfo(optional)This field is not directly modifiable and is generally expected to be null. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.[default to undefined]
enabled(optional) booleanWhether the Role is enabled or not.[default to false]
requestable(optional) booleanWhether the Role can be the target of access requests.[default to false]
accessRequestConfig(optional) Requestabilityforrole[default to undefined]
revocationRequestConfig(optional) Revocabilityforrole[default to undefined]
segments(optional) Array<string>List of IDs of segments, if any, to which this Role is assigned.[default to undefined]
dimensional(optional) booleanWhether the Role is dimensional.[default to false]
dimensionRefs(optional) Array<Dimensionref>List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional.[default to undefined]
accessModelMetadata(optional) Attributedtolist[default to undefined]
privilegeLevel(optional) stringThe privilege level of the role, if applicable.[default to undefined]