Invite a user to a tenant

Allows an authenticated tenant member to invite another user via email. The invitee will receive an email and must accept the invitation.

POST /v2/databases/{database}/tenants/{tenantId}/invite

Invite a user to a tenant

cURL

curl --request POST \
  --url https://api.example.com/v2/databases/{database}/tenants/{tenantId}/invite \
  --header 'Content-Type: multipart/form-data' \
  --cookie nile-auth.session-token= \
  --form identifier=[e-mail] \
  --form 'csrfToken=<string>' \
  --form 'redirectUrl=<string>' \
  --form 'callbackUrl=<string>'

import requests

url = "https://api.example.com/v2/databases/{database}/tenants/{tenantId}/invite"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"identifier\"\r\n\r\[e-mail]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"csrfToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "cookie": "nile-auth.session-token=",
    "Content-Type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append('identifier', '[e-mail]');
form.append('csrfToken', '<string>');
form.append('redirectUrl', '<string>');
form.append('callbackUrl', '<string>');

const options = {method: 'POST', headers: {cookie: 'nile-auth.session-token='}};

options.body = form;

fetch('https://api.example.com/v2/databases/{database}/tenants/{tenantId}/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.example.com/v2/databases/{database}/tenants/{tenantId}/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 => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"identifier\"\r\n\r\[e-mail]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"csrfToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_COOKIE => "nile-auth.session-token=",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data"
  ],
]);

$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.example.com/v2/databases/{database}/tenants/{tenantId}/invite"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"identifier\"\r\n\r\[e-mail]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"csrfToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

	req.Header.Add("cookie", "nile-auth.session-token=")

	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.example.com/v2/databases/{database}/tenants/{tenantId}/invite")
  .header("cookie", "nile-auth.session-token=")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"identifier\"\r\n\r\[e-mail]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"csrfToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/databases/{database}/tenants/{tenantId}/invite")

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

request = Net::HTTP::Post.new(url)
request["cookie"] = 'nile-auth.session-token='
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"identifier\"\r\n\r\[e-mail]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"csrfToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

200

{
  "status": "success",
  "message": "Invite email sent"
}

"<string>"

"<string>"

"<string>"

"<string>"

Authorizations

nile-auth.session-token · string · cookie · required

Session token stored in a cookie after user signs in, prefixed with __Secure if on https

Path Parameters

database · string · required

tenantId · string · required

Body

multipart/form-data

identifier · string<email> · required

Email address of the user being invited

csrfToken · string · required

CSRF token for request validation

redirectUrl · string<uri> · required

URL to redirect the user to after accepting the invite

callbackUrl · string<uri> · required

Callback URL to include in the invitation email

Response

200

application/json

Invite sent successfully

status · string

Example:

"success"

message · string

Example:

"Invite email sent"