INVITE USER

Syntax

INVITE USER email_address [, ...]
[ WITH (invitation_parameter = value [, ...]) ];

Description

This lets an Organization user manager invite users into an Organization. The primary role name assigned to the user will be reserved and kept inactive until the user accepts the invitation. If the user rejects the invitation, the role is dropped as well. Additional roles, as well as a default role, can be assigned to the user’s primary role when the invitation is created.

Users can only be invited by a Role with MANAGE_MEMBERS privilege.

Arguments

email_address

The email address of the user(s) to invite into the current Organization.

WITH invitation_parameter = [, ...]

Optionally, this clause specifies Invitation Parameters.

Invitation Parameters

Parameter NameDescription

roles

Specifies a list of additional roles to grant to the user role once the invitation is accepted.

Required: No

Default value: []

Type: List Valid values: See LIST ROLES

default

Specifies the role that should be the default login role for the user. Required: Yes Default value: None Type: String Valid values: See LIST ROLES

Example

Invite a new user to an Organization with specific roles

INVITE USER 'someone@somewhere.com' WITH (
    'roles' = (a_role, sysadmin),
    'default' = sysadmin
);

Invite multiple users to an Organization with specific roles

<no-db>/<no-store># INVITE USER 'someone@somewhere.com', 'someone@somewhereelse.com' WITH ('default' = sysadmin , 'roles' = (a_role, sysadmin));
+------------+--------------------------------------+----------+------------------------------------------+
|  Type      |  Name                                |  Command |  Summary                                 |
+============+======================================+==========+==========================================+
| invitation | b4f99db5-9d1e-4682-a2b4-940a181b27e1 | CREATE   | invitation for "someone@somewhere.com"   |
|            |                                      |          | was successfully created                 |
+------------+--------------------------------------+----------+------------------------------------------+
| invitation | 89ba9a85-9eef-4795-a84e-70c8480a823f | CREATE   | invitation for                           |
|            |                                      |          | "someone@somewhereelse.com" was          |
|            |                                      |          | successfully created                     |
+------------+--------------------------------------+----------+------------------------------------------+
PreviousGRANT ROLENextLIST API_TOKENS

Last updated