Add a realm member
Sets the role of someone who is already a member of the realm, or adds a group. People
join a realm through Send an invitation, not here; daemons join with a realm token.
member_id may be a user id, username or email.
Requires a realm admin with the realms.members.manage permission on the realm that owns the realm given by realm_id.
POST
/
v1
/
realms
/
add_member
Add a realm member
curl --request POST \
--url https://{host}/v1/realms/add_member \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"member_type": "user",
"member_id": "jdoe",
"role": "operator"
}
'import requests
url = "https://{host}/v1/realms/add_member"
payload = {
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"member_type": "user",
"member_id": "jdoe",
"role": "operator"
}
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({
realm_id: '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
member_type: 'user',
member_id: 'jdoe',
role: 'operator'
})
};
fetch('https://{host}/v1/realms/add_member', 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://{host}/v1/realms/add_member",
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([
'realm_id' => '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
'member_type' => 'user',
'member_id' => 'jdoe',
'role' => 'operator'
]),
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://{host}/v1/realms/add_member"
payload := strings.NewReader("{\n \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n \"member_type\": \"user\",\n \"member_id\": \"jdoe\",\n \"role\": \"operator\"\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://{host}/v1/realms/add_member")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n \"member_type\": \"user\",\n \"member_id\": \"jdoe\",\n \"role\": \"operator\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/realms/add_member")
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 \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n \"member_type\": \"user\",\n \"member_id\": \"jdoe\",\n \"role\": \"operator\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"member": {
"id": "7e8f90a1-b2c3-4d4e-8f5a-6b7c8d9e0f1a",
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"member_type": "user",
"member_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"username": "jdoe",
"role": "operator",
"created_at": 1759100000000
}
}
Authorizations
User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).
Body
application/json
Realm UUID
Minimum string length:
1Member kind (daemon enroll is via realm token, not this route)
Available options:
user, daemon, group Hub user id of an existing realm member when member_type=user (new people: invitations/create); group id otherwise
Minimum string length:
1Grant role
Available options:
admin, operator, member ⌘I
Add a realm member
curl --request POST \
--url https://{host}/v1/realms/add_member \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"member_type": "user",
"member_id": "jdoe",
"role": "operator"
}
'import requests
url = "https://{host}/v1/realms/add_member"
payload = {
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"member_type": "user",
"member_id": "jdoe",
"role": "operator"
}
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({
realm_id: '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
member_type: 'user',
member_id: 'jdoe',
role: 'operator'
})
};
fetch('https://{host}/v1/realms/add_member', 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://{host}/v1/realms/add_member",
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([
'realm_id' => '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
'member_type' => 'user',
'member_id' => 'jdoe',
'role' => 'operator'
]),
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://{host}/v1/realms/add_member"
payload := strings.NewReader("{\n \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n \"member_type\": \"user\",\n \"member_id\": \"jdoe\",\n \"role\": \"operator\"\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://{host}/v1/realms/add_member")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n \"member_type\": \"user\",\n \"member_id\": \"jdoe\",\n \"role\": \"operator\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/realms/add_member")
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 \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n \"member_type\": \"user\",\n \"member_id\": \"jdoe\",\n \"role\": \"operator\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"member": {
"id": "7e8f90a1-b2c3-4d4e-8f5a-6b7c8d9e0f1a",
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"member_type": "user",
"member_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"username": "jdoe",
"role": "operator",
"created_at": 1759100000000
}
}