DirectusInstall

Summary

Invite a new user to Directus by sending an invitation email.

Inputs

• Email (required) — User email address - they will receive an invite email at this address
• Role Name or ID — User role - if not provided, the default role will be assigned. Choose from the list, or specify an ID using an expression.
• Custom Invite URL — Optional custom URL for the invite link. If not provided, the default Directus invite URL will be used. Must be configured in USER_INVITE_URL_ALLOW_LIST environment variable.

Output shape

object

Returns the created user object from the Directus API. If the Simplify option is enabled on the node, the user data is reduced to essential fields.

Examples

Example 1: Invite a user with a specific role

Set Email to 'alice@example.com', Role Name or ID to 'Editor'

Example 2: Invite a user using a custom invite link

Set Email to 'bob@example.com', Custom Invite URL to 'https://example.com/accept-invite={{$json.token}}'