White Label Admin - Add user to a project

DEPRECATED. White label admin only API to add a user to a project. If no user is provided, the current user is used.

POST /api/organizations/{organizationId}/whitelabel/projects/{projectId}/members

White Label Admin - Add user to a project

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "usernameOrEmail": "janjongboom"
}
'

import requests

url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members"

payload = { "usernameOrEmail": "janjongboom" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({usernameOrEmail: 'janjongboom'})
};

fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members', 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://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members",
  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([
    'usernameOrEmail' => 'janjongboom'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members"

	payload := strings.NewReader("{\n  \"usernameOrEmail\": \"janjongboom\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"usernameOrEmail\": \"janjongboom\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"usernameOrEmail\": \"janjongboom\"\n}"

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

200

{
  "success": true,
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

projectId · integer · required

Project ID

Body

application/json

usernameOrEmail · string

Username or email of the user to be added to the project or organization. If no user is provided, the user ID attached to the JWT will be used.

Example:

"janjongboom"

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

Optional error description (set if 'success' was false)