Get app permission definition

Returns the app’s static tool catalog — the read/write groups and tool IDs that the permissions endpoints (/rules/permissions/{provider} and /org/rules/permissions/{provider}) operate on. Global data; works without a project context, so organization keys can call it without X-Project-Id.

GET /apps/{provider}/permission-definition

Get app permission definition

cURL

curl --request GET \
  --url https://api.onecli.sh/v1/apps/{provider}/permission-definition \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.onecli.sh/v1/apps/{provider}/permission-definition"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onecli.sh/v1/apps/{provider}/permission-definition', 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.onecli.sh/v1/apps/{provider}/permission-definition",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.onecli.sh/v1/apps/{provider}/permission-definition"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.onecli.sh/v1/apps/{provider}/permission-definition")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/apps/{provider}/permission-definition")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "provider": "<string>",
  "groups": [
    {
      "tools": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "wildcard": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>"
      }
    }
  ]
}

{
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

API key obtained from the dashboard or GET /user/api-key

Path Parameters

provider · string · required

App provider identifier (e.g., gmail, github, jira)

Response

200

application/json

Permission definition

An app's static tool catalog — the tool IDs that the permissions endpoints operate on.

provider · string

groups · object[]

Show child attributes