Permission rules

Replace the whole permission document

Replaces every group and every permission at once.

PUT/v1/apps/{appId}/rules

Request

curl --request PUT \
  --url 'https://studio.gtable.app/v1/apps/<appId>/rules' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version": 123.45,
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "permissions": [
    {
      "group": "<string>",
      "tables": "<string>"
    }
  ]
}'

import json
import requests

url = "https://studio.gtable.app/v1/apps/<appId>/rules"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"version\":123.45,\"groups\":[{\"id\":\"<string>\",\"name\":\"<string>\"}],\"permissions\":[{\"group\":\"<string>\",\"tables\":\"<string>\"}]}")

response = requests.request("PUT", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.gtable.app/v1/apps/<appId>/rules", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "version": 123.45,
    "groups": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "permissions": [
      {
        "group": "<string>",
        "tables": "<string>"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.gtable.app/v1/apps/<appId>/rules");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"version\":123.45,\"groups\":[{\"id\":\"<string>\",\"name\":\"<string>\"}],\"permissions\":[{\"group\":\"<string>\",\"tables\":\"<string>\"}]}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("PUT", "https://studio.gtable.app/v1/apps/<appId>/rules", bytes.NewBuffer([]byte("{\"version\":123.45,\"groups\":[{\"id\":\"<string>\",\"name\":\"<string>\"}],\"permissions\":[{\"group\":\"<string>\",\"tables\":\"<string>\"}]}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.gtable.app/v1/apps/<appId>/rules"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"version\":123.45,\"groups\":[{\"id\":\"<string>\",\"name\":\"<string>\"}],\"permissions\":[{\"group\":\"<string>\",\"tables\":\"<string>\"}]}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.gtable.app/v1/apps/<appId>/rules")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"version\":123.45,\"groups\":[{\"id\":\"<string>\",\"name\":\"<string>\"}],\"permissions\":[{\"group\":\"<string>\",\"tables\":\"<string>\"}]}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "version": 123.45,
    "groups": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "assistantMonthlyCredits": 123,
        "interface": "assigned"
      }
    ],
    "permissions": [
      {
        "group": "<string>",
        "tables": "<string>"
      }
    ],
    "revision": "<string>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

This is the call for adding or removing a GROUP; to change what one group may do, prefer groups.setPermissions, which cannot touch the others by accident. Send the revision rules.get gave you as baseRevision, and a save made after somebody else changed the document is refused with 409 rather than erasing their change.

Requires the schema:write scope. Operation rules.set. MCP tool rules_set. CLI, once published: gtable rules set.

Path parameters

Name	Type	Required	Description
`appId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`version`	2	yes
`groups`	object[]	yes	1 to 100 items.
`permissions`	object[]	yes	Up to 100 items.
`baseRevision`	string	no

Response

application/json

Success

dataobjectrequired

Show child attributes

versionnumberrequired

groupsobject[]required

permissionsobject[]required

revisionstringrequired

curl --request PUT \ --url 'https://studio.gtable.app/v1/apps/<appId>/rules' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "version": 123.45, "groups": [ { "id": "<string>", "name": "<string>" } ], "permissions": [ { "group": "<string>", "tables": "<string>" } ] }'

{ "data": { "version": 123.45, "groups": [ { "id": "<string>", "name": "<string>", "description": "<string>", "assistantMonthlyCredits": 123, "interface": "assigned" } ], "permissions": [ { "group": "<string>", "tables": "<string>" } ], "revision": "<string>" } }

Replace the whole permission document

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown