Invite someone
curl --request POST \
--url http://localhost:3000/api/v1/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": []
}
'import requests
url = "http://localhost:3000/api/v1/invitations"
payload = {
"email": "[email protected]",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": []
}
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: '[email protected]',
resourceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
limits: []
})
};
fetch('http://localhost:3000/api/v1/invitations', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/invitations",
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]',
'resourceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'limits' => [
]
]),
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 := "http://localhost:3000/api/v1/invitations"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"limits\": []\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("http://localhost:3000/api/v1/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"limits\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/invitations")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"limits\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"resource": "organization",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"scope": "read",
"limits": [
"delete"
],
"invitedBy": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"url": "<string>",
"emailed": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}API Reference
Invite someone
A grant waiting for whoever holds the link: they make an account or sign in, and have it. The url is in this response only. It works once, for seven days. Same rules as giving a grant.
Any caller; the scope needed is checked on what it acts on.
POST
/
api
/
v1
/
invitations
Invite someone
curl --request POST \
--url http://localhost:3000/api/v1/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": []
}
'import requests
url = "http://localhost:3000/api/v1/invitations"
payload = {
"email": "[email protected]",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": []
}
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: '[email protected]',
resourceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
limits: []
})
};
fetch('http://localhost:3000/api/v1/invitations', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/invitations",
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]',
'resourceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'limits' => [
]
]),
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 := "http://localhost:3000/api/v1/invitations"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"limits\": []\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("http://localhost:3000/api/v1/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"limits\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/invitations")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"limits\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"resource": "organization",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"scope": "read",
"limits": [
"delete"
],
"invitedBy": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"url": "<string>",
"emailed": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Authorizations
bearersession
An API key: ab_...
Body
application/json
Maximum string length:
320Pattern:
^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$What the grant is on; it reaches everything inside it
Available options:
organization, workspace, collection, asset The organization's, workspace's, collection's or asset's id
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
read, propose, write, admin What the scope would allow but this grant doesn't: delete, share (links and upload requests), approve (review), setup (fields and brand)
Maximum array length:
4Available options:
delete, share, approve, setup Response
The invitation, with its link
Show child attributes
Show child attributes