Directus / @directus/sdk / rest / inviteUser
Function: inviteUser()
inviteUser<
Schema
>(role
,invite_url
?):RestCommand
<void
,Schema
>
Invite a new user by email.
Type parameters
• Schema extends object
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