Get an app's tool catalog

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))

}

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

{
  "provider": "<string>",
  "groups": [
    {
      "category": "read",
      "tools": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "wildcard": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>"
      },
      "wildcardComplete": true
    }
  ],
  "unlisted": "block"
}

{
  "error": "<string>"
}

GET

apps

{provider}

permission-definition

Get an app's tool catalog

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))

}

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

{
  "provider": "<string>",
  "groups": [
    {
      "category": "read",
      "tools": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "wildcard": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>"
      },
      "wildcardComplete": true
    }
  ],
  "unlisted": "block"
}

{
  "error": "<string>"
}

Use it to look up valid tool ids before you write a custom grant or a rule. No workspace context is needed. See Rules and Agent access. The tool ids a grant’s allow/ask lists and a policy rule’s tools may reference. No workspace context needed.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

provider

string

required

App provider identifier (for example gmail, github, jira).

Response

The catalog

An app's static tool catalog — the tool IDs that grants and policy rules operate on.

provider

string

groups

object[]

Show child attributes

unlisted

enum<string>

Present when requests outside the catalog are blocked under a customized grant.

Available options:

block

Workspace

Organization

Enterprise

Platform

Get an app's tool catalog

Authorizations

Path Parameters

Response