Invite Member
curl --request POST \
--url http://localhost:8000/tenant/members/invite \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"role": "tenant_admin"
}
'import requests
url = "http://localhost:8000/tenant/members/invite"
payload = {
"email": "[email protected]",
"role": "tenant_admin"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', role: 'tenant_admin'})
};
fetch('http://localhost:8000/tenant/members/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_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/tenant/members/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' => '[email protected]',
'role' => 'tenant_admin'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:8000/tenant/members/invite"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"role\": \"tenant_admin\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:8000/tenant/members/invite")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"role\": \"tenant_admin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/tenant/members/invite")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"role\": \"tenant_admin\"\n}"
response = http.request(request)
puts response.read_body{
"email": "[email protected]",
"invited_at": "2024-01-01T00:00:00Z",
"last_login_at": "2024-06-01T12:00:00Z",
"member_id": "aa0e8400-e29b-41d4-a716-446655440000",
"name": "Jane Doe",
"role": "tenant_admin",
"status": "active",
"user_id": "bb0e8400-e29b-41d4-a716-446655440000"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}tenant
Invite Member
POST
/
tenant
/
members
/
invite
Invite Member
curl --request POST \
--url http://localhost:8000/tenant/members/invite \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"role": "tenant_admin"
}
'import requests
url = "http://localhost:8000/tenant/members/invite"
payload = {
"email": "[email protected]",
"role": "tenant_admin"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', role: 'tenant_admin'})
};
fetch('http://localhost:8000/tenant/members/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_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/tenant/members/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' => '[email protected]',
'role' => 'tenant_admin'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:8000/tenant/members/invite"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"role\": \"tenant_admin\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:8000/tenant/members/invite")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"role\": \"tenant_admin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/tenant/members/invite")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"role\": \"tenant_admin\"\n}"
response = http.request(request)
puts response.read_body{
"email": "[email protected]",
"invited_at": "2024-01-01T00:00:00Z",
"last_login_at": "2024-06-01T12:00:00Z",
"member_id": "aa0e8400-e29b-41d4-a716-446655440000",
"name": "Jane Doe",
"role": "tenant_admin",
"status": "active",
"user_id": "bb0e8400-e29b-41d4-a716-446655440000"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Cookies
Body
application/json
Schema for inviting a new member to a tenant.
Email address of the user to invite
Maximum string length:
255Pattern:
^[^@\s]+@[^@\s]+\.[^@\s]+$Role to assign to the invited member (platform_admin not allowed)
Available options:
platform_admin, tenant_owner, tenant_admin, billing_operator, accountant, viewer ⌘I