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 / inviteUser

Function: inviteUser() ​

inviteUser<Schema>(email, role, invite_url?): RestCommand<void, Schema>

Defined in: rest/commands/utils/users.ts:13

Invite a new user by email.

Type Parameters ​

• Schema

Parameters ​

email ​

string

User email to invite.

role ​

string

Role of the new user.

invite_url? ​

string

Provide a custom invite url which the link in the email will lead to. The invite token will be passed as a parameter.

Returns ​

RestCommand<void, Schema>

Nothing