Reorder organization policy rules

Reorder organization rules

curl --request PUT \
  --url https://api.onecli.sh/v1/org/policy/rules/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderedIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.onecli.sh/v1/org/policy/rules/order"

payload = { "orderedIds": ["<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({orderedIds: ['<string>']})
};

fetch('https://api.onecli.sh/v1/org/policy/rules/order', 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/org/policy/rules/order",
  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([
    'orderedIds' => [
        '<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://api.onecli.sh/v1/org/policy/rules/order"

	payload := strings.NewReader("{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\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://api.onecli.sh/v1/org/policy/rules/order")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/policy/rules/order")

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  \"orderedIds\": [\n    \"<string>\"\n  ]\n}"

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

[
  {
    "id": "<string>",
    "scope": "organization",
    "status": "draft",
    "generation": 123,
    "priority": 123,
    "enabled": true,
    "isDefault": true,
    "logicalId": "<string>",
    "source": "<string>",
    "name": "<string>",
    "description": "<string>",
    "action": "allow",
    "rateLimit": 123,
    "rateLimitWindow": "minute",
    "requireApproval": true,
    "conditions": "<unknown>",
    "identities": [
      {
        "type": "agent",
        "id": "<string>"
      }
    ],
    "targets": [
      {
        "kind": "app",
        "provider": "<string>",
        "tools": [
          "<string>"
        ],
        "connectionScope": "organization",
        "connectionId": "<string>",
        "secretId": "<string>",
        "secretScope": "organization",
        "hostPattern": "<string>",
        "pathPattern": "<string>",
        "method": "GET"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

{
  "error": "<string>"
}

{
  "error": "<string>"
}

PUT

org

policy

rules

order

Reorder organization rules

curl --request PUT \
  --url https://api.onecli.sh/v1/org/policy/rules/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderedIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.onecli.sh/v1/org/policy/rules/order"

payload = { "orderedIds": ["<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({orderedIds: ['<string>']})
};

fetch('https://api.onecli.sh/v1/org/policy/rules/order', 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/org/policy/rules/order",
  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([
    'orderedIds' => [
        '<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://api.onecli.sh/v1/org/policy/rules/order"

	payload := strings.NewReader("{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\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://api.onecli.sh/v1/org/policy/rules/order")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/policy/rules/order")

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  \"orderedIds\": [\n    \"<string>\"\n  ]\n}"

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

[
  {
    "id": "<string>",
    "scope": "organization",
    "status": "draft",
    "generation": 123,
    "priority": 123,
    "enabled": true,
    "isDefault": true,
    "logicalId": "<string>",
    "source": "<string>",
    "name": "<string>",
    "description": "<string>",
    "action": "allow",
    "rateLimit": 123,
    "rateLimitWindow": "minute",
    "requireApproval": true,
    "conditions": "<unknown>",
    "identities": [
      {
        "type": "agent",
        "id": "<string>"
      }
    ],
    "targets": [
      {
        "kind": "app",
        "provider": "<string>",
        "tools": [
          "<string>"
        ],
        "connectionScope": "organization",
        "connectionId": "<string>",
        "secretId": "<string>",
        "secretScope": "organization",
        "hostPattern": "<string>",
        "pathPattern": "<string>",
        "method": "GET"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Sets the first-match order of organization rules. Include every non-default rule exactly once. If someone changed the rules since you last read them, the call returns 409 so you can reload and retry. Related guide: Rules: control what agents can do. Sets first-match order. orderedIds must name every non-default rule exactly once; a stale list answers 409.

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.

Body

application/json

orderedIds

string[]

required

Minimum array length: 1

Response

The reordered rules

string

scope

enum<string>

Available options:

organization,

workspace

status

enum<string>

Available options:

draft,

published

generation

integer

0 for the draft working copy; the snapshot number for published rows.

priority

integer

First-match order (lower evaluates first).

enabled

boolean

isDefault

boolean

True on the scope's terminal Default Rule.

logicalId

string

Generation-stable identity; compare rules across draft/published by this, never by id.

source

string

custom (user-owned, editable), default (the Default Rule), or system-managed rows: blocklist (compiled from app blocklists) and, at workspace scope, grant (compiled from agent grants; managed through the Grants endpoints, never edited as rules).

name

string

description

string | null

action

enum<string>

Available options:

allow,

block

rateLimit

integer | null

rateLimitWindow

enum<string> | null

Available options:

minute,

hour,

day,

null

requireApproval

boolean

conditions

any | null

A conditions array, a session-policy object ({repositories} / {folders} / {driveFolders}), or null.

identities

object[]

Show child attributes

targets

object[]

Show child attributes

createdAt

string<date-time>

Workspace

Organization

Enterprise

Platform

Reorder organization policy rules

Authorizations

Body

Response