Convidar membro - Square Cloud

POST

workspaces

members

Convidar membro

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

Authorization

string

obrigatório

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

Adiciona um membro a um espaço de trabalho usando um código de curta duração obtido em Obter código de convite: o usuário convidado é identificado pelo código, e quem faz a chamada define o papel dele com group. Somente o dono do espaço de trabalho pode chamar este endpoint, e o número de membros é limitado pelo plano do dono. Os quatro papéis atribuíveis controlam o que um membro pode fazer nas aplicações compartilhadas do espaço de trabalho: view é somente leitura; manager pode acionar ações da aplicação (iniciar/parar/reiniciar) e ver informações de deploy, mas não fazer commit nem mexer em arquivos; maintain acrescenta gerenciamento de arquivos, DNS, limpeza de cache e commits; admin acrescenta variáveis de ambiente, snapshots, domínios personalizados e o webhook de deploy. Altere um papel depois com Alterar permissões. Um dono não pode convidar a si mesmo. Limitado a 1 adição a cada 5 segundos por usuário.

Parâmetros

workspaceId

string

O ID do espaço de trabalho.

code

string

Uma string com o código de convite 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.
`INVALID_CODE`	400	O código de convite está ausente, é inválido ou expirou.
`CANNOT_INVITE_OWNER`	400	O código de convite pertence a quem fez a chamada, que já é dono do espaço de trabalho.
`INVALID_GROUP`	400	`group` não é `view`, `manager`, `maintain` ou `admin`.
`MEMBERS_LIMIT_REACHED`	400	O espaço de trabalho já atingiu o número máximo de membros do plano.
`MEMBER_ALREADY_ADDED`	400	O usuário convidado já é membro deste espaço de trabalho.
`WORKSPACE_NOT_FOUND`	404	O espaço de trabalho não existe.

Remover membroRemover um membro do espaço de trabalho.

Convidar membro

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

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns