UpdateRoleInput is an input datatype for updating a role. It's used by the updateRole() mutation field.

Table: UpdateRoleInput

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Aug 18, 2025
colorstring  Long-TermThe color for displaying the role.
descriptionstring  Long-TermThe description of the role to update.
displayNamestringyes Long-TermThe display name of the role to update.
objectActionObjectAction  Long-TermThe object of the action. See ObjectAction.
organizationManagementPermissions[OrganizationManagementPermission]  Long-TermList of permissions given for organization management. See OrganizationManagementPermission.
organizationPermissions[OrganizationPermission]  Long-TermList of permissions given for the organization. See OrganizationPermission.
roleIdstringyes Long-TermThe unique identifier of the role to update.
systemPermissions[SystemPermission]  Long-TermList of permissions given for users who are assigned the role. See SystemPermission.
viewPermissions[Permission]yes Long-TermA list of permissions associated with the view. See Permission.