Evaluate a provider-runtime permission request
curl --request POST \
--url http://localhost:3000/api/v1/permissions/check \
--header 'Content-Type: application/json' \
--data '
{
"localOperator": true,
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/permissions/check"
payload = {
"localOperator": True,
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
localOperator: true,
objectId: '<string>',
objectType: '<string>',
permission: '<string>'
})
};
fetch('http://localhost:3000/api/v1/permissions/check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/permissions/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'localOperator' => true,
'objectId' => '<string>',
'objectType' => '<string>',
'permission' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/permissions/check"
payload := strings.NewReader("{\n \"localOperator\": true,\n \"objectId\": \"<string>\",\n \"objectType\": \"<string>\",\n \"permission\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("http://localhost:3000/api/v1/permissions/check")
.header("Content-Type", "application/json")
.body("{\n \"localOperator\": true,\n \"objectId\": \"<string>\",\n \"objectType\": \"<string>\",\n \"permission\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/permissions/check")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"localOperator\": true,\n \"objectId\": \"<string>\",\n \"objectType\": \"<string>\",\n \"permission\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"allowed": true,
"decision": {
"allowed": true,
"decision": "allow",
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>",
"providerId": "<string>",
"providerVersion": "<string>",
"reasonCode": "<string>",
"contextId": "<string>",
"durationMs": 123,
"evidence": [
{
"kind": "<string>",
"message": "<string>",
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>",
"providerId": "<string>",
"source": "<string>"
}
],
"requestId": "<string>",
"subject": {
"id": "<string>",
"type": "<string>"
}
},
"diagnosticNote": "<string>",
"guidance": {
"breakGlass": "<string>",
"canonicalCapability": "<string>",
"inspectCommands": [
"<string>"
],
"nextSteps": [
"<string>"
],
"preferredPath": {
"kind": "<string>",
"message": "<string>",
"suggestedTags": [
{
"capabilities": [
"<string>"
],
"label": "<string>",
"slug": "<string>",
"description": "<string>"
}
],
"allowCommand": "<string>"
},
"rawCapabilityFallback": "<string>",
"requestShape": {
"profileOrTag": "<string>",
"reason": "<string>",
"scope": "<string>",
"ttl": "<string>",
"subject": "<string>"
},
"scope": "<string>",
"candidateCapabilities": [
"<string>"
]
}
}permissions
Evaluate a provider-runtime permission request
POST
/
api
/
v1
/
permissions
/
check
Evaluate a provider-runtime permission request
curl --request POST \
--url http://localhost:3000/api/v1/permissions/check \
--header 'Content-Type: application/json' \
--data '
{
"localOperator": true,
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/permissions/check"
payload = {
"localOperator": True,
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
localOperator: true,
objectId: '<string>',
objectType: '<string>',
permission: '<string>'
})
};
fetch('http://localhost:3000/api/v1/permissions/check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/permissions/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'localOperator' => true,
'objectId' => '<string>',
'objectType' => '<string>',
'permission' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/permissions/check"
payload := strings.NewReader("{\n \"localOperator\": true,\n \"objectId\": \"<string>\",\n \"objectType\": \"<string>\",\n \"permission\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("http://localhost:3000/api/v1/permissions/check")
.header("Content-Type", "application/json")
.body("{\n \"localOperator\": true,\n \"objectId\": \"<string>\",\n \"objectType\": \"<string>\",\n \"permission\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/permissions/check")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"localOperator\": true,\n \"objectId\": \"<string>\",\n \"objectType\": \"<string>\",\n \"permission\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"allowed": true,
"decision": {
"allowed": true,
"decision": "allow",
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>",
"providerId": "<string>",
"providerVersion": "<string>",
"reasonCode": "<string>",
"contextId": "<string>",
"durationMs": 123,
"evidence": [
{
"kind": "<string>",
"message": "<string>",
"objectId": "<string>",
"objectType": "<string>",
"permission": "<string>",
"providerId": "<string>",
"source": "<string>"
}
],
"requestId": "<string>",
"subject": {
"id": "<string>",
"type": "<string>"
}
},
"diagnosticNote": "<string>",
"guidance": {
"breakGlass": "<string>",
"canonicalCapability": "<string>",
"inspectCommands": [
"<string>"
],
"nextSteps": [
"<string>"
],
"preferredPath": {
"kind": "<string>",
"message": "<string>",
"suggestedTags": [
{
"capabilities": [
"<string>"
],
"label": "<string>",
"slug": "<string>",
"description": "<string>"
}
],
"allowCommand": "<string>"
},
"rawCapabilityFallback": "<string>",
"requestShape": {
"profileOrTag": "<string>",
"reason": "<string>",
"scope": "<string>",
"ttl": "<string>",
"subject": "<string>"
},
"scope": "<string>",
"candidateCapabilities": [
"<string>"
]
}
}Body
application/json