Modifier les permissions

PATCH

workspaces

members

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', memberId: '<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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'memberId' => '<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  \"memberId\": \"<string>\",\n  \"group\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.squarecloud.app/v2/workspaces/members")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"memberId\": \"<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::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"memberId\": \"<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.

Change le rôle d’un membre existant du workspace, avec effet immédiat sur son accès aux applications partagées du workspace. Les quatre rôles sont view (lecture seule), manager (actions sur l’application et informations de déploiement), maintain (ajoute les fichiers, le DNS, le vidage de cache et les commits) et admin (ajoute les variables d’environnement, les snapshots, les domaines personnalisés et le webhook de déploiement). Seul le propriétaire du workspace peut appeler cet endpoint, et le propriétaire ne peut pas changer son propre rôle puisqu’il dispose toujours d’un accès complet. Pour ajouter un nouveau membre plutôt que de modifier un membre existant, consultez Inviter un membre. Limité à 3 modifications par 15 secondes par utilisateur.

Paramètres

string

L’ID du workspace.

string

L’ID 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.
`MEMBER_NOT_FOUND`	400	`memberId` est manquant ou n’appartient pas au workspace.
`CANNOT_EDIT_OWNER`	400	L’appelant a tenté de changer son propre rôle.
`INVALID_GROUP`	400	`group` n’est pas l’une des valeurs `view`, `manager`, `maintain`, `admin`.
`WORKSPACE_NOT_FOUND`	404	Le workspace n’existe pas.

Ajouter une applicationAjoutez une application au workspace.

Modifier les permissions

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', memberId: '<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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'memberId' => '<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  \"memberId\": \"<string>\",\n  \"group\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.squarecloud.app/v2/workspaces/members")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"memberId\": \"<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::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"memberId\": \"<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