PlatformRoleMethods
Methods attached to role objects returned by the Roles service.
Methods¶
delete()¶
delete():
Promise<void>
Deletes this role. Built-in roles cannot be deleted.
Returns¶
Promise<void>
Promise resolving when the role has been deleted
update()¶
update(
update:PlatformRoleUpdateOptions):Promise<PlatformRoleGetResponse>
Updates this role. Only the fields present in update are changed.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
update |
PlatformRoleUpdateOptions |
The fields to change |
Returns¶
Promise<PlatformRoleGetResponse>
Promise resolving to the role as stored after the update