Skip to content

PlatformRoleUpdateOptions

Fields to change on a custom role via roles.updateById(). Only the fields present are changed — omitted fields keep their current values.

Properties

Property Type Description
actionsGrantedByRole? string[] Replaces the full set of granted actions — pick names from roles.getActions().
description? string New description.
name? string New role name.
ownerServiceName? string Name of the service that owns the role.
scopeType? PlatformRoleScopeType New level the role applies at.
tenantId? string Tenant the role belongs to, for tenant-scoped roles.