curl --request POST \
--url https://workspace.basaltic.sh/v1/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "john.doe@acme.com",
"tags": {
"environment": "production",
"team": "backend"
},
"groups": [
"crn:workspace:::group/developers"
]
}
'import requests
url = "https://workspace.basaltic.sh/v1/users"
payload = {
"email": "john.doe@acme.com",
"tags": {
"environment": "production",
"team": "backend"
},
"groups": ["crn:workspace:::group/developers"]
}
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: 'john.doe@acme.com',
tags: {environment: 'production', team: 'backend'},
groups: ['crn:workspace:::group/developers']
})
};
fetch('https://workspace.basaltic.sh/v1/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://workspace.basaltic.sh/v1/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([
'email' => 'john.doe@acme.com',
'tags' => [
'environment' => 'production',
'team' => 'backend'
],
'groups' => [
'crn:workspace:::group/developers'
]
]),
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://workspace.basaltic.sh/v1/users"
payload := strings.NewReader("{\n \"email\": \"john.doe@acme.com\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"groups\": [\n \"crn:workspace:::group/developers\"\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://workspace.basaltic.sh/v1/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john.doe@acme.com\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"groups\": [\n \"crn:workspace:::group/developers\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://workspace.basaltic.sh/v1/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 \"email\": \"john.doe@acme.com\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"groups\": [\n \"crn:workspace:::group/developers\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"invitation": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "jane.doe@example.com",
"groups": [
{
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "developers"
}
],
"invited_by": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"email": "john.doe@acme.com",
"type": "user",
"crn": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"status": "pending",
"expires_at": "2026-01-22T09:30:00Z",
"created_at": "2026-01-15T09:30:00Z",
"crn": "crn:workspace:::invitation/550e8400-e29b-41d4-a716-446655440002"
},
"status": "invited"
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Adicionar usuário à organização
Convide um usuário para a organização por email. Um e-mail de convite é sempre enviado e o usuário se junta ao aceitá-lo — não há nenhum caminho que adicione alguém sem o consentimento dele, mesmo que ele já tenha uma conta na plataforma. Convidar um membro existente ou alguém que já tenha um convite pendente é rejeitado com 409.
Opcionalmente, especifique grupos para adicionar o usuário na aceitação.
curl --request POST \
--url https://workspace.basaltic.sh/v1/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "john.doe@acme.com",
"tags": {
"environment": "production",
"team": "backend"
},
"groups": [
"crn:workspace:::group/developers"
]
}
'import requests
url = "https://workspace.basaltic.sh/v1/users"
payload = {
"email": "john.doe@acme.com",
"tags": {
"environment": "production",
"team": "backend"
},
"groups": ["crn:workspace:::group/developers"]
}
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: 'john.doe@acme.com',
tags: {environment: 'production', team: 'backend'},
groups: ['crn:workspace:::group/developers']
})
};
fetch('https://workspace.basaltic.sh/v1/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://workspace.basaltic.sh/v1/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([
'email' => 'john.doe@acme.com',
'tags' => [
'environment' => 'production',
'team' => 'backend'
],
'groups' => [
'crn:workspace:::group/developers'
]
]),
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://workspace.basaltic.sh/v1/users"
payload := strings.NewReader("{\n \"email\": \"john.doe@acme.com\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"groups\": [\n \"crn:workspace:::group/developers\"\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://workspace.basaltic.sh/v1/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john.doe@acme.com\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"groups\": [\n \"crn:workspace:::group/developers\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://workspace.basaltic.sh/v1/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 \"email\": \"john.doe@acme.com\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"groups\": [\n \"crn:workspace:::group/developers\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"invitation": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "jane.doe@example.com",
"groups": [
{
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "developers"
}
],
"invited_by": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"email": "john.doe@acme.com",
"type": "user",
"crn": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"status": "pending",
"expires_at": "2026-01-22T09:30:00Z",
"created_at": "2026-01-15T09:30:00Z",
"crn": "crn:workspace:::invitation/550e8400-e29b-41d4-a716-446655440002"
},
"status": "invited"
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}workspace:AddUser. Consulte permissões de Workspace para obter a lista completa, o que cada uma abrange e um exemplo de política.Authorizations
Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.
Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.
Headers
Chave opcional gerada pelo cliente que torna uma criação segura para reprodução. A reintentar uma solicitação com a mesma chave retorna o resultado original literalmente em vez de criar um recurso duplicado. A reutilização de uma chave com um corpo de solicitação diferente é rejeitada (422); uma solicitação cuja chave ainda está sendo processada retorna 409. Os registros são honrados por 24 horas. Use um UUID ou token exclusivo semelhante.
255Body
E-mail do usuário a adicionar
"john.doe@acme.com"
Show child attributes
Show child attributes
{
"environment": "production",
"team": "backend"
}
Grupos a serem atribuídos quando o convite for aceito. Cada referência é validada na organização do chamador antes que o convite seja criado.
UUID do grupo, nome imutável na organização autenticada ou um CRN do espaço de trabalho na organização autenticada. Os grupos contêm apenas usuários.
Response
Convite criado e enviado por e-mail

