Provision embed users in bulk
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"users": [
{
"externalId": "<string>",
"email": "jsmith@example.com",
"groups": [
"<string>"
],
"tenantGroups": [
"<string>"
],
"userProfile": {
"displayName": "<string>",
"picture": "<string>"
}
}
]
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users"
payload = { "users": [
{
"externalId": "<string>",
"email": "jsmith@example.com",
"groups": ["<string>"],
"tenantGroups": ["<string>"],
"userProfile": {
"displayName": "<string>",
"picture": "<string>"
}
}
] }
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({
users: [
{
externalId: '<string>',
email: 'jsmith@example.com',
groups: ['<string>'],
tenantGroups: ['<string>'],
userProfile: {displayName: '<string>', picture: '<string>'}
}
]
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users', 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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users",
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([
'users' => [
[
'externalId' => '<string>',
'email' => 'jsmith@example.com',
'groups' => [
'<string>'
],
'tenantGroups' => [
'<string>'
],
'userProfile' => [
'displayName' => '<string>',
'picture' => '<string>'
]
]
]
]),
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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users"
payload := strings.NewReader("{\n \"users\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"groups\": [\n \"<string>\"\n ],\n \"tenantGroups\": [\n \"<string>\"\n ],\n \"userProfile\": {\n \"displayName\": \"<string>\",\n \"picture\": \"<string>\"\n }\n }\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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"groups\": [\n \"<string>\"\n ],\n \"tenantGroups\": [\n \"<string>\"\n ],\n \"userProfile\": {\n \"displayName\": \"<string>\",\n \"picture\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users")
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 \"users\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"groups\": [\n \"<string>\"\n ],\n \"tenantGroups\": [\n \"<string>\"\n ],\n \"userProfile\": {\n \"displayName\": \"<string>\",\n \"picture\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"failed": [
{
"error": {
"message": "<string>",
"status": 123
},
"externalId": "<string>"
}
],
"succeeded": [
{
"id": 123,
"username": "<string>",
"createdAt": "2023-12-25",
"email": "<string>",
"externalId": "<string>",
"firstName": "<string>",
"lastLogin": "2023-12-25"
}
]
}Embed Tenants
Provision embed users in bulk
POST
/
api
/
v1
/
embed-tenants
/
{embedTenantName}
/
users
Provision embed users in bulk
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"users": [
{
"externalId": "<string>",
"email": "jsmith@example.com",
"groups": [
"<string>"
],
"tenantGroups": [
"<string>"
],
"userProfile": {
"displayName": "<string>",
"picture": "<string>"
}
}
]
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users"
payload = { "users": [
{
"externalId": "<string>",
"email": "jsmith@example.com",
"groups": ["<string>"],
"tenantGroups": ["<string>"],
"userProfile": {
"displayName": "<string>",
"picture": "<string>"
}
}
] }
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({
users: [
{
externalId: '<string>',
email: 'jsmith@example.com',
groups: ['<string>'],
tenantGroups: ['<string>'],
userProfile: {displayName: '<string>', picture: '<string>'}
}
]
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users', 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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users",
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([
'users' => [
[
'externalId' => '<string>',
'email' => 'jsmith@example.com',
'groups' => [
'<string>'
],
'tenantGroups' => [
'<string>'
],
'userProfile' => [
'displayName' => '<string>',
'picture' => '<string>'
]
]
]
]),
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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users"
payload := strings.NewReader("{\n \"users\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"groups\": [\n \"<string>\"\n ],\n \"tenantGroups\": [\n \"<string>\"\n ],\n \"userProfile\": {\n \"displayName\": \"<string>\",\n \"picture\": \"<string>\"\n }\n }\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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"groups\": [\n \"<string>\"\n ],\n \"tenantGroups\": [\n \"<string>\"\n ],\n \"userProfile\": {\n \"displayName\": \"<string>\",\n \"picture\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/users")
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 \"users\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"groups\": [\n \"<string>\"\n ],\n \"tenantGroups\": [\n \"<string>\"\n ],\n \"userProfile\": {\n \"displayName\": \"<string>\",\n \"picture\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"failed": [
{
"error": {
"message": "<string>",
"status": 123
},
"externalId": "<string>"
}
],
"succeeded": [
{
"id": 123,
"username": "<string>",
"createdAt": "2023-12-25",
"email": "<string>",
"externalId": "<string>",
"firstName": "<string>",
"lastLogin": "2023-12-25"
}
]
}Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Path Parameters
Name of the embed tenant (the embedTenantName used to generate embed sessions).
Body
application/json
ProvisionEmbedUsersInput
Embed users to provision (1–100 per request).
Required array length:
1 - 100 elementsShow child attributes
Show child attributes