Replace your application's acceptance policy
curl --request PUT \
--url https://api.baselayer.com/acceptance/policy \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"steps": [
{
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"rules": [
{
"name": "<string>",
"when": {
"transport": [],
"kind": [],
"trust": []
},
"requirement": {
"kind": "scope",
"scope": "shop-example#checkout",
"identity_level": null,
"challenge": null
}
}
],
"detection_fallback": "local_rules"
}
],
"conversions": [
{
"name": "<string>",
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"response_statuses": [
200,
201,
303
],
"activity_type": "purchase"
}
]
}
'import requests
url = "https://api.baselayer.com/acceptance/policy"
payload = {
"steps": [
{
"match": {
"paths": ["/checkout/**"],
"methods": ["POST"],
"mcp_tools": ["<string>"],
"ucp_operations": ["<string>"]
},
"rules": [
{
"name": "<string>",
"when": {
"transport": [],
"kind": [],
"trust": []
},
"requirement": {
"kind": "scope",
"scope": "shop-example#checkout",
"identity_level": None,
"challenge": None
}
}
],
"detection_fallback": "local_rules"
}
],
"conversions": [
{
"name": "<string>",
"match": {
"paths": ["/checkout/**"],
"methods": ["POST"],
"mcp_tools": ["<string>"],
"ucp_operations": ["<string>"]
},
"response_statuses": [200, 201, 303],
"activity_type": "purchase"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
steps: [
{
match: {
paths: ['/checkout/**'],
methods: ['POST'],
mcp_tools: ['<string>'],
ucp_operations: ['<string>']
},
rules: [
{
name: '<string>',
when: {transport: [], kind: [], trust: []},
requirement: {
kind: 'scope',
scope: 'shop-example#checkout',
identity_level: null,
challenge: null
}
}
],
detection_fallback: 'local_rules'
}
],
conversions: [
{
name: '<string>',
match: {
paths: ['/checkout/**'],
methods: ['POST'],
mcp_tools: ['<string>'],
ucp_operations: ['<string>']
},
response_statuses: [200, 201, 303],
activity_type: 'purchase'
}
]
})
};
fetch('https://api.baselayer.com/acceptance/policy', 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.baselayer.com/acceptance/policy",
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([
'steps' => [
[
'match' => [
'paths' => [
'/checkout/**'
],
'methods' => [
'POST'
],
'mcp_tools' => [
'<string>'
],
'ucp_operations' => [
'<string>'
]
],
'rules' => [
[
'name' => '<string>',
'when' => [
'transport' => [
],
'kind' => [
],
'trust' => [
]
],
'requirement' => [
'kind' => 'scope',
'scope' => 'shop-example#checkout',
'identity_level' => null,
'challenge' => null
]
]
],
'detection_fallback' => 'local_rules'
]
],
'conversions' => [
[
'name' => '<string>',
'match' => [
'paths' => [
'/checkout/**'
],
'methods' => [
'POST'
],
'mcp_tools' => [
'<string>'
],
'ucp_operations' => [
'<string>'
]
],
'response_statuses' => [
200,
201,
303
],
'activity_type' => 'purchase'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.baselayer.com/acceptance/policy"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"transport\": [],\n \"kind\": [],\n \"trust\": []\n },\n \"requirement\": {\n \"kind\": \"scope\",\n \"scope\": \"shop-example#checkout\",\n \"identity_level\": null,\n \"challenge\": null\n }\n }\n ],\n \"detection_fallback\": \"local_rules\"\n }\n ],\n \"conversions\": [\n {\n \"name\": \"<string>\",\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"response_statuses\": [\n 200,\n 201,\n 303\n ],\n \"activity_type\": \"purchase\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.baselayer.com/acceptance/policy")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"transport\": [],\n \"kind\": [],\n \"trust\": []\n },\n \"requirement\": {\n \"kind\": \"scope\",\n \"scope\": \"shop-example#checkout\",\n \"identity_level\": null,\n \"challenge\": null\n }\n }\n ],\n \"detection_fallback\": \"local_rules\"\n }\n ],\n \"conversions\": [\n {\n \"name\": \"<string>\",\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"response_statuses\": [\n 200,\n 201,\n 303\n ],\n \"activity_type\": \"purchase\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/acceptance/policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"steps\": [\n {\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"transport\": [],\n \"kind\": [],\n \"trust\": []\n },\n \"requirement\": {\n \"kind\": \"scope\",\n \"scope\": \"shop-example#checkout\",\n \"identity_level\": null,\n \"challenge\": null\n }\n }\n ],\n \"detection_fallback\": \"local_rules\"\n }\n ],\n \"conversions\": [\n {\n \"name\": \"<string>\",\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"response_statuses\": [\n 200,\n 201,\n 303\n ],\n \"activity_type\": \"purchase\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_number": 2,
"environment": "sandbox",
"policy_hash": "sha256:0000000000000000000000000000000000000000000000000000000000000000",
"created_at": "2023-11-07T05:31:56Z",
"minimum_policy_schema_version": 2,
"policy": {
"steps": [
{
"name": "browse",
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"enforcement_mode": "report_only",
"rules": [
{
"name": "<string>",
"when": {
"transport": [
"browser"
],
"kind": [
"human"
],
"trust": [
"credentialed"
],
"minimum_identity_level": "L1"
},
"outcome": "allow",
"requirement": {
"kind": "scope",
"scope": "shop-example#checkout",
"identity_level": null,
"challenge": null
}
}
],
"detection_fallback": "local_rules"
}
],
"conversions": [
{
"name": "<string>",
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"response_statuses": [
200,
201,
303
],
"activity_type": "purchase",
"event_kind": "search"
}
]
},
"warnings": [
{
"code": "partly_shadowed_step",
"message": "<string>",
"step": "browse",
"shadowed_by": "browse",
"rule": "<string>",
"conversion": "<string>"
}
],
"created_by": {
"kind": "USER",
"label": "<string>"
}
}{
"type": "policy_version_stale",
"code": 7221,
"message": "The acceptance policy has changed since the version you edited. Read it again and reapply your change.",
"metadata": {}
}{
"type": "validation_failed",
"code": 7112,
"message": "The request is invalid.",
"metadata": {}
}{
"type": "if_match_required",
"code": 7220,
"message": "A replace needs an If-Match header naming the version you edited.",
"metadata": {}
}Policy
Replace your application's acceptance policy
Makes the body the next version of your application’s policy. Send the ETag of the version you edited as If-Match; if another write made a newer version first, the replace is refused and nothing changes. The body is exactly the policy a read returns.
PUT
/
acceptance
/
policy
Replace your application's acceptance policy
curl --request PUT \
--url https://api.baselayer.com/acceptance/policy \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"steps": [
{
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"rules": [
{
"name": "<string>",
"when": {
"transport": [],
"kind": [],
"trust": []
},
"requirement": {
"kind": "scope",
"scope": "shop-example#checkout",
"identity_level": null,
"challenge": null
}
}
],
"detection_fallback": "local_rules"
}
],
"conversions": [
{
"name": "<string>",
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"response_statuses": [
200,
201,
303
],
"activity_type": "purchase"
}
]
}
'import requests
url = "https://api.baselayer.com/acceptance/policy"
payload = {
"steps": [
{
"match": {
"paths": ["/checkout/**"],
"methods": ["POST"],
"mcp_tools": ["<string>"],
"ucp_operations": ["<string>"]
},
"rules": [
{
"name": "<string>",
"when": {
"transport": [],
"kind": [],
"trust": []
},
"requirement": {
"kind": "scope",
"scope": "shop-example#checkout",
"identity_level": None,
"challenge": None
}
}
],
"detection_fallback": "local_rules"
}
],
"conversions": [
{
"name": "<string>",
"match": {
"paths": ["/checkout/**"],
"methods": ["POST"],
"mcp_tools": ["<string>"],
"ucp_operations": ["<string>"]
},
"response_statuses": [200, 201, 303],
"activity_type": "purchase"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
steps: [
{
match: {
paths: ['/checkout/**'],
methods: ['POST'],
mcp_tools: ['<string>'],
ucp_operations: ['<string>']
},
rules: [
{
name: '<string>',
when: {transport: [], kind: [], trust: []},
requirement: {
kind: 'scope',
scope: 'shop-example#checkout',
identity_level: null,
challenge: null
}
}
],
detection_fallback: 'local_rules'
}
],
conversions: [
{
name: '<string>',
match: {
paths: ['/checkout/**'],
methods: ['POST'],
mcp_tools: ['<string>'],
ucp_operations: ['<string>']
},
response_statuses: [200, 201, 303],
activity_type: 'purchase'
}
]
})
};
fetch('https://api.baselayer.com/acceptance/policy', 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.baselayer.com/acceptance/policy",
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([
'steps' => [
[
'match' => [
'paths' => [
'/checkout/**'
],
'methods' => [
'POST'
],
'mcp_tools' => [
'<string>'
],
'ucp_operations' => [
'<string>'
]
],
'rules' => [
[
'name' => '<string>',
'when' => [
'transport' => [
],
'kind' => [
],
'trust' => [
]
],
'requirement' => [
'kind' => 'scope',
'scope' => 'shop-example#checkout',
'identity_level' => null,
'challenge' => null
]
]
],
'detection_fallback' => 'local_rules'
]
],
'conversions' => [
[
'name' => '<string>',
'match' => [
'paths' => [
'/checkout/**'
],
'methods' => [
'POST'
],
'mcp_tools' => [
'<string>'
],
'ucp_operations' => [
'<string>'
]
],
'response_statuses' => [
200,
201,
303
],
'activity_type' => 'purchase'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.baselayer.com/acceptance/policy"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"transport\": [],\n \"kind\": [],\n \"trust\": []\n },\n \"requirement\": {\n \"kind\": \"scope\",\n \"scope\": \"shop-example#checkout\",\n \"identity_level\": null,\n \"challenge\": null\n }\n }\n ],\n \"detection_fallback\": \"local_rules\"\n }\n ],\n \"conversions\": [\n {\n \"name\": \"<string>\",\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"response_statuses\": [\n 200,\n 201,\n 303\n ],\n \"activity_type\": \"purchase\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.baselayer.com/acceptance/policy")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"transport\": [],\n \"kind\": [],\n \"trust\": []\n },\n \"requirement\": {\n \"kind\": \"scope\",\n \"scope\": \"shop-example#checkout\",\n \"identity_level\": null,\n \"challenge\": null\n }\n }\n ],\n \"detection_fallback\": \"local_rules\"\n }\n ],\n \"conversions\": [\n {\n \"name\": \"<string>\",\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"response_statuses\": [\n 200,\n 201,\n 303\n ],\n \"activity_type\": \"purchase\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/acceptance/policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"steps\": [\n {\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"transport\": [],\n \"kind\": [],\n \"trust\": []\n },\n \"requirement\": {\n \"kind\": \"scope\",\n \"scope\": \"shop-example#checkout\",\n \"identity_level\": null,\n \"challenge\": null\n }\n }\n ],\n \"detection_fallback\": \"local_rules\"\n }\n ],\n \"conversions\": [\n {\n \"name\": \"<string>\",\n \"match\": {\n \"paths\": [\n \"/checkout/**\"\n ],\n \"methods\": [\n \"POST\"\n ],\n \"mcp_tools\": [\n \"<string>\"\n ],\n \"ucp_operations\": [\n \"<string>\"\n ]\n },\n \"response_statuses\": [\n 200,\n 201,\n 303\n ],\n \"activity_type\": \"purchase\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_number": 2,
"environment": "sandbox",
"policy_hash": "sha256:0000000000000000000000000000000000000000000000000000000000000000",
"created_at": "2023-11-07T05:31:56Z",
"minimum_policy_schema_version": 2,
"policy": {
"steps": [
{
"name": "browse",
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"enforcement_mode": "report_only",
"rules": [
{
"name": "<string>",
"when": {
"transport": [
"browser"
],
"kind": [
"human"
],
"trust": [
"credentialed"
],
"minimum_identity_level": "L1"
},
"outcome": "allow",
"requirement": {
"kind": "scope",
"scope": "shop-example#checkout",
"identity_level": null,
"challenge": null
}
}
],
"detection_fallback": "local_rules"
}
],
"conversions": [
{
"name": "<string>",
"match": {
"paths": [
"/checkout/**"
],
"methods": [
"POST"
],
"mcp_tools": [
"<string>"
],
"ucp_operations": [
"<string>"
]
},
"response_statuses": [
200,
201,
303
],
"activity_type": "purchase",
"event_kind": "search"
}
]
},
"warnings": [
{
"code": "partly_shadowed_step",
"message": "<string>",
"step": "browse",
"shadowed_by": "browse",
"rule": "<string>",
"conversion": "<string>"
}
],
"created_by": {
"kind": "USER",
"label": "<string>"
}
}{
"type": "policy_version_stale",
"code": 7221,
"message": "The acceptance policy has changed since the version you edited. Read it again and reapply your change.",
"metadata": {}
}{
"type": "validation_failed",
"code": 7112,
"message": "The request is invalid.",
"metadata": {}
}{
"type": "if_match_required",
"code": 7220,
"message": "A replace needs an If-Match header naming the version you edited.",
"metadata": {}
}Authorizations
Headers
The ETag of the version the body was edited from, as a read or a replace returned it. It matches while it names the current policy_version_id, whatever the audiences hash in it.
Body
application/jsonapplication/vnd.baselayer.v1+json
Response
The new current version.
One immutable version of an application's acceptance policy.
The version's id.
Its number; version 1 is the default.
Required range:
x >= 1The application's environment.
Available options:
sandbox, production sha256: and the hex digest of the policy body the SDK ran.
Pattern:
^sha256:[0-9a-f]{64}$Example:
"sha256:0000000000000000000000000000000000000000000000000000000000000000"
When the version was made.
The policy feature level an SDK needs to enforce this version; below it the SDK runs it report-only.
Required range:
x >= 1The rules.
Show child attributes
Show child attributes
Steps or rules that are allowed but suspect.
Show child attributes
Show child attributes
Who made it; null for the seeded default.
Show child attributes
Show child attributes