Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / deleteRole

Function: deleteRole() ​

deleteRole<Schema>(key): RestCommand<void, Schema>

Defined in: rest/commands/delete/roles.ts:30

Delete an existing role.

Type Parameters ​

• Schema

Parameters ​

key ​

DirectusRole<Schema>["id"]

Returns ​

RestCommand<void, Schema>

Throws ​

Will throw if key is empty