Invite a user | emnify Documentation

Invite a user to a Workspace by specifying username and the roles that the user will have in the organization. This user is created and a User invited event is sent. There is no additional action such as an email sent.

The following fields may be provided:

username (String) - Email of the invited user
name (String) - Name of the invited user
organisation (Object) - Defaults to the default Workspace of the requesting user
roles (Array) - Assigns the Administrator role by default

If the invited user doesn’t exist, a new user is created and the organisation.id is their default Workspace. If the invited user already exists, the user is assigned to the Workspace. This fails if the Workspace feature isn’t enabled on the target organization’s tariff plan.

Invite a user to a Workspace by specifying username and the roles that the user will have in the organization. This user is created and a `User invited` event is sent. There is no additional action such as an email sent. The following fields may be provided: - `username` (String) - Email of the invited user - `name` (String) - Name of the invited user - `organisation` (Object) - Defaults to the default Workspace of the requesting user - `roles` (Array) - Assigns the **Administrator** role by default If the invited user doesn't exist, a new user is created and the `organisation.id` is their default Workspace. If the invited user already exists, the user is assigned to the Workspace. This fails if the Workspace feature isn't enabled on the target organization's tariff plan.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.

usernamestringRequired

namestringRequired

organisationobjectOptional

roleslist of objectsOptional

Response

User created successfully

iddouble or null

usernamestring or null

namestring or null

organisationobject or null

roleslist of objects or null

Errors

The following fields may be provided:

username (String) - Email of the invited user
name (String) - Name of the invited user
organisation (Object) - Defaults to the default Workspace of the requesting user
roles (Array) - Assigns the Administrator role by default

1	{
2	"id": 207531,
3	"username": "john.funky@company.org",
4	"name": "John Funky Jazz",
5	"organisation": {
6	"id": 6797
7	},
8	"roles": [
9	{
10	"id": 1,
11	"name": "Administrator"
12	},
13	{
14	"id": 2,
15	"name": "User"
16	}
17	]
18	}