Update Team Group - Serval Documentation

PUT

/

v2

/

teams

/

{team_id}

/

groups

/

{group_id}

Update Team Group

curl --request PUT \
  --url https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}"

payload = { "id": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({id: '<string>'})
};

fetch('https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}', 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://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>'
  ]),
  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://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\"\n}"

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

{
  "data": {
    "teamId": "<string>",
    "groupId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>"
  }
}

{
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id

string

required

group_id

string

required

Body

application/json

role

enum<string>

required

The role this group's members get on the team. Other grants on the team — other groups' bindings and direct user memberships — are left untouched. One binding row carries exactly one grant, so this replaces whatever this group held on this team, including a custom role; assign custom roles through the custom-role endpoints.

Available options:

TEAM_USER_ROLE_UNSPECIFIED,

TEAM_USER_ROLE_AGENT,

TEAM_USER_ROLE_MANAGER,

TEAM_USER_ROLE_BUILDER,

TEAM_USER_ROLE_VIEWER,

TEAM_USER_ROLE_CONTRIBUTOR,

TEAM_USER_ROLE_DRAFTER,

TEAM_USER_ROLE_READONLY_AGENT,

TEAM_USER_ROLE_APP_BUILDER

id

string

Composite identifier ({team_id}:{group_id}). Alternative to team_id + group_id.

Response

Success

data

data · object

Show child attributes

Update Team Group

curl --request PUT \
  --url https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}"

payload = { "id": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({id: '<string>'})
};

fetch('https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}', 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://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>'
  ]),
  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://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/teams/{team_id}/groups/{group_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\"\n}"

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

{
  "data": {
    "teamId": "<string>",
    "groupId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>"
  }
}

{
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}