Invite a user to the tenant via email

Security Requirements

Auth Types	Entities	Permissions	Required Roles
USER	USERS	WRITE	USERS:WRITE

POST /tenant-auth/v1/users/invite

Invite a user to the tenant via email

cURL

curl --request POST \
  --url https://api.swarmd.ai/tenant-auth/v1/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "groupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.swarmd.ai/tenant-auth/v1/users/invite"

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "groupIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    groupIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.swarmd.ai/tenant-auth/v1/users/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swarmd.ai/tenant-auth/v1/users/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'groupIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swarmd.ai/tenant-auth/v1/users/invite"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"groupIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.swarmd.ai/tenant-auth/v1/users/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"groupIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swarmd.ai/tenant-auth/v1/users/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"groupIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "permissions": [
    {}
  ],
  "firstName": "<string>",
  "lastName": "<string>",
  "source": "<string>",
  "groupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

Authorization · string · header · required

JWT token (USER, AGENT, or SERVICE auth)

Body

application/json

email · string · required

Pattern: ^[^+]*$

firstName · string · required

Maximum string length: 255

lastName · string · required

Maximum string length: 255

groupIds · string<uuid>[]

Response

201 - */*

Created

id · string<uuid> · required

tenantId · string<uuid> · required

email · string · required

createdAt · string<date-time> · required

status · enum<string> · required

Available options: ACTIVE, PENDING, DISABLED

permissions · object[] · required

Show child attributes

firstName · string

lastName · string

source · string

groupIds · string<uuid>[]