Inviter un membre - Square Cloud

POST

workspaces

members

Inviter un membre

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces/members \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "code": "<string>",
  "group": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces/members"

payload = {
    "workspaceId": "<string>",
    "code": "<string>",
    "group": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', code: '<string>', group: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces/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://api.squarecloud.app/v2/workspaces/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([
    'workspaceId' => '<string>',
    'code' => '<string>',
    'group' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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://api.squarecloud.app/v2/workspaces/members"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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://api.squarecloud.app/v2/workspaces/members")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/members")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}"

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

{
  "status": "success"
}

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Ajoute un membre à un workspace à l’aide d’un code à courte durée de vie obtenu via Obtenir le code d’invitation : l’utilisateur invité est identifié par le code, et l’appelant lui attribue un rôle via group. Seul le propriétaire du workspace peut appeler cet endpoint, et le nombre de membres du workspace est plafonné selon le palier de plan du propriétaire. Les quatre rôles attribuables déterminent ce qu’un membre peut faire sur les applications partagées du workspace : view est en lecture seule ; manager peut déclencher des actions sur l’application (démarrer/arrêter/redémarrer) et voir les informations de déploiement, mais pas commit ni toucher aux fichiers ; maintain ajoute la gestion de fichiers, le DNS, le vidage de cache et les commits ; admin ajoute les variables d’environnement, les snapshots, les domaines personnalisés et le webhook de déploiement. Changez un rôle plus tard avec Modifier les permissions. Un propriétaire ne peut pas s’inviter lui-même. Limité à 1 ajout toutes les 5 secondes par utilisateur.

Paramètres

string

L’ID du workspace.

string

Une chaîne contenant le code d’invitation du membre.

string

Les permissions du membre sur les applications du workspace

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

{
  "status": "success"
}

Erreurs courantes

Code	HTTP	Signification
`INVALID_ID`	400	`workspaceId` est manquant.
`INVALID_CODE`	400	Le code d’invitation est manquant, mal formé, ou a expiré.
`CANNOT_INVITE_OWNER`	400	Le code d’invitation appartient à l’appelant, qui possède déjà le workspace.
`INVALID_GROUP`	400	`group` n’est pas l’une des valeurs `view`, `manager`, `maintain`, `admin`.
`MEMBERS_LIMIT_REACHED`	400	Le workspace a déjà atteint le nombre maximal de membres de son plan.
`MEMBER_ALREADY_ADDED`	400	L’utilisateur invité est déjà membre de ce workspace.
`WORKSPACE_NOT_FOUND`	404	Le workspace n’existe pas.

Retirer un membreRetirez un membre d'un workspace.

Inviter un membre

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces/members \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "code": "<string>",
  "group": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces/members"

payload = {
    "workspaceId": "<string>",
    "code": "<string>",
    "group": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', code: '<string>', group: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces/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://api.squarecloud.app/v2/workspaces/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([
    'workspaceId' => '<string>',
    'code' => '<string>',
    'group' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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://api.squarecloud.app/v2/workspaces/members"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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://api.squarecloud.app/v2/workspaces/members")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/members")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}"

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

{
  "status": "success"
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes