Alterar permissões - Square Cloud

PATCH

workspaces

members

Alterar permissões

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"
}

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Altera o papel de um membro já existente no espaço de trabalho, com efeito imediato sobre o acesso dele às aplicações compartilhadas do espaço de trabalho. Os quatro papéis são view (somente leitura), manager (ações da aplicação e informações de deploy), maintain (acrescenta arquivos, DNS, limpeza de cache e commits) e admin (acrescenta variáveis de ambiente, snapshots, domínios personalizados e o webhook de deploy). Somente o dono do espaço de trabalho pode chamar este endpoint, e o dono não pode alterar o próprio papel, já que sempre tem acesso total. Para adicionar um novo membro em vez de alterar um existente, veja Convidar membro. Limitado a 3 edições a cada 15 segundos por usuário.

Parâmetros

workspaceId

string

O ID do espaço de trabalho.

memberId

string

O ID do membro.

group

string

As permissões do membro nas aplicações do espaço de trabalho.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

{
  "status": "success"
}

Erros comuns

Código	HTTP	Significado
`INVALID_ID`	400	`workspaceId` está ausente.
`MEMBER_NOT_FOUND`	400	`memberId` está ausente ou não pertence ao espaço de trabalho.
`CANNOT_EDIT_OWNER`	400	O solicitante tentou alterar o próprio papel.
`INVALID_GROUP`	400	`group` não é `view`, `manager`, `maintain` ou `admin`.
`WORKSPACE_NOT_FOUND`	404	O espaço de trabalho não existe.

Adicionar aplicaçãoAdicionar uma aplicação ao espaço de trabalho.

Alterar permissões

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"
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns