Adds a rule just above the Default Rule. It takes effect immediately in every workspace. Use it to set guardrails no workspace can override. See Rules for the available actions.Appended just above the Default Rule and enforced immediately.
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
A rule must name at least one target (an empty or missing targets list is refused with 422). rateLimit/rateLimitWindow are paired and, like requireApproval, valid only with action: allow. On Cloud, rateLimit needs the Pro plan or above and group identities need the Enterprise plan; manual approval is available on every plan.
name
string
required
Maximum string length: 255
action
enum<string>
required
Available options:
allow,
block
targets
object[]
required
Required array length: 1 - 100 elements
Show child attributes
description
string
Maximum string length: 1000
enabled
boolean
default:true
rateLimit
integer
Required range: 1 <= x <= 1000000
rateLimitWindow
enum<string>
Available options:
minute,
hour,
day
requireApproval
boolean
conditions
any
A conditions array (max 10) or a session-policy object ({repositories: [...]} / {folders: [...]} / {driveFolders: [...]}; allow rules with a connection target only).
identities
object[]
Maximum array length: 100
Show child attributes
Response
The rule
A policy-engine rule. Every write is enforced immediately; the draft/published split survives only for older clients. Published row ids regenerate on every publish; logicalId is the identity stable across statuses and generations.
id
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>
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Buckle","colors":{"primary":"#ff6a13","light":"#ff8236","dark":"#e55e0f"},"logo":{"light":"https://mintcdn.com/onecli-17d3f772/5_AFCR2UNaqNo0AT/logo/logo-full-light.svg?fit=max\u0026auto=format\u0026n=5_AFCR2UNaqNo0AT\u0026q=85\u0026s=30ceea1dd3505e0e9dea50b544521ced","dark":"https://mintcdn.com/onecli-17d3f772/5_AFCR2UNaqNo0AT/logo/logo-full-dark.svg?fit=max\u0026auto=format\u0026n=5_AFCR2UNaqNo0AT\u0026q=85\u0026s=120ef96cf376422549781454d97dd810","href":"https://buckle.dev"},"favicon":"https://mintcdn.com/onecli-17d3f772/hJP3XqgFsBDnXHKy/favicon.svg?fit=max\u0026auto=format\u0026n=hJP3XqgFsBDnXHKy\u0026q=85\u0026s=ddda982106e5fd52c3815a54c183f4b1","appearance":{"default":"light"},"background":{"color":{"light":"#FAFAF9","dark":"#1A1918"}},"navbar":{"links":[{"href":"https://github.com/trybuckle/buckle","label":"GitHub"},{"href":"https://buckle.dev","label":"Install"}]},"footer":{"socials":{"github":"https://github.com/trybuckle"}},"fonts":{"heading":{"family":"Chakra Petch","weight":700,"source":"fonts/ChakraPetch-700.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"https://mintlify.s3.us-west-1.amazonaws.com/onecli-17d3f772/images/github.svg","href":"https://github.com/buckle"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onecli-17d3f772","hasAudioNarration":false,"actualSubdomain":"onecli-17d3f772","customDomains":[],"gitSource":{"type":"github","owner":"trybuckle","repo":"buckle-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6af9ac749033d7e87e8c505a"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af9b4b9e79e0e5d703531fb","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":240},{"language":"default","tag":"Workspace","count":105},{"language":"default","tag":"Integrations","count":88},{"language":"default","tag":"All app connections","count":64},{"language":"default","tag":"Enterprise","count":57},{"language":"default","tag":"Organization","count":52},{"language":"default","tag":"Apps","count":29},{"language":"default","tag":"Channels","count":28},{"language":"default","tag":"Platform","count":21},{"language":"default","tag":"Guides","count":17}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"a.nav-anchor div.mr-4.rounded-md{--tw-ring-color: transparent !important;--tw-ring-shadow: 0 0 0 0 transparent !important;--tw-ring-offset-shadow: 0 0 0 0 transparent !important;box-shadow:none!important;background:transparent!important;filter:none!important;transition:opacity 0.15s ease!important}a.nav-anchor:hover div.mr-4.rounded-md{--tw-ring-color: transparent !important;--tw-ring-shadow: 0 0 0 0 transparent !important;--tw-ring-offset-shadow: 0 0 0 0 transparent !important;box-shadow:none!important;background:transparent!important;filter:none!important;opacity:0.7!important}a.nav-anchor div.mr-4.rounded-md img{opacity:1!important;filter:none!important;background:transparent!important}a.nav-anchor:hover div.mr-4.rounded-md img{opacity:1!important;filter:none!important;background:transparent!important}.dark a.nav-anchor div.mr-4.rounded-md img,[data-theme=\"dark\"] a.nav-anchor div.mr-4.rounded-md img{filter:invert(1)!important}"}],"page":{"pagePath":"api-reference/organization-policy/create-an-organization-rule","slug":"/api-reference/organization-policy/create-an-organization-rule","pageMetadata":{"title":"Create an organization policy rule","description":"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.","deprecated":null,"version":null,"sidebarTitle":"Create an organization rule","openapi":"/openapi.yaml post /org/policy/rules","href":"/api-reference/organization-policy/create-an-organization-rule","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Adds a rule just above the Default Rule. It takes effect immediately in every workspace. Use it to set guardrails no workspace can override. See `,_jsx(_components.a,{href:`/guides/rules`,children:`Rules`}),` for the available actions.`]}),`\n`,_jsx(_components.p,{children:`Appended just above the Default Rule and enforced immediately.`}),`\n`,_jsxs(Info,{children:[_jsx(_components.strong,{children:`Availability:`}),` Cloud · Community (self-hosted) · Enterprise (self-hosted)`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an organization policy rule","description":"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.","deprecated":null,"version":null,"sidebarTitle":"Create an organization rule","openapi":"/openapi.yaml post /org/policy/rules","href":"/api-reference/organization-policy/create-an-organization-rule","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/onecli-17d3f772/e8c5fc0faf4d8de9/infra/cloudfront/docs-response-headers.js"],"openApiReferenceData":{"operation":{"operationId":"createOrgPolicyRule","summary":"Create an organization rule","description":"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.","tags":["Organization policy"],"x-mint":{"metadata":{"title":"Create an organization policy rule","sidebarTitle":"Create an organization rule","description":"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace."},"content":"Adds a rule just above the Default Rule. It takes effect immediately in every workspace. Use it to set guardrails no workspace can override. See [Rules](/guides/rules) for the available actions.\n\nAppended just above the Default Rule and enforced immediately.\n\n\u003cInfo>**Availability:** Cloud · Community (self-hosted) · Enterprise (self-hosted)\u003c/Info>\n"},"requestBody":"36b37c73-33e1-483e-87d0-e646e8a42373","responses":{"201":"2aca8333-6781-4770-a6e2-a41feefdb1b8","403":"04fe42c6-2b9c-47c5-827a-8c80e97d7398","422":"39130e61-397d-4cd0-bded-c673e1d1276c"},"method":"post","type":"path","servers":["b3977aeb-de68-4d84-b6e0-fa89b0232679","f6588b3c-095c-481a-8524-52287902fa98"],"security":["60fa197f-31bd-4ed4-b029-08e7e575c688"],"path":"/org/policy/rules","baseUrlOptions":["https://api.buckle.dev/v1","http://localhost:10254/v1"],"title":"Create an organization rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"A rule must name at least one target (an empty or missing `targets` list is refused with `422`). `rateLimit`/`rateLimitWindow` are paired and, like `requireApproval`, valid only with `action: allow`. On Cloud, `rateLimit` needs the Pro plan or above and `group` identities need the Enterprise plan; manual approval is available on every plan.","required":["name","action","targets"],"properties":{"name":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"action":{"type":"string","enum":["allow","block"],"isRequired":true,"uniqueKey":"action","typeLabel":"enum\u003cstring>"},"targets":{"type":"array","maxItems":100,"minItems":1,"items":{"type":"object","description":"One destination the rule matches, a discriminated union on `kind`: an `app` target (provider, optionally narrowed by `tools`), a `connection` target (`connectionId`, optional `tools`), a `secret` target (a specific `secretId` XOR a `secretScope` level), or a `network` target (host/path/method patterns). A rule needs at least one target.","required":["kind"],"properties":{"kind":{"type":"string","enum":["app","connection","secret","network"],"isRequired":true,"uniqueKey":"targets.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"`app` targets: the provider id (for example `gmail`).","uniqueKey":"targets.items.[INDEX].provider","typeLabel":"string"},"tools":{"type":"array","maxItems":100,"items":{"type":"string","uniqueKey":"targets.items.[INDEX].tools.items.[INDEX]","typeLabel":"string"},"description":"`app`/`connection` targets: narrow matching to these catalog tool ids; empty = the whole app.","uniqueKey":"targets.items.[INDEX].tools","typeLabel":"string[]"},"connectionScope":{"oneOf":[{"type":"string","enum":["organization","workspace"],"description":"`app` targets: set = inject all the agent's connections of the provider at that level; `null` (or omitted on write) = a block/allow layer with no injection.","uniqueKey":"targets.items.[INDEX].connectionScope.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["organization","workspace"],"description":"`app` targets: set = inject all the agent's connections of the provider at that level; `null` (or omitted on write) = a block/allow layer with no injection.","uniqueKey":"targets.items.[INDEX].connectionScope.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].connectionScope","typeLabel":"enum\u003cstring> | null"},"connectionId":{"type":"string","description":"`connection` targets: the connection id.","uniqueKey":"targets.items.[INDEX].connectionId","typeLabel":"string"},"secretId":{"type":"string","description":"`secret` targets: a specific secret (mutually exclusive with `secretScope`).","uniqueKey":"targets.items.[INDEX].secretId","typeLabel":"string"},"secretScope":{"type":"string","enum":["organization","workspace"],"description":"`secret` targets: all the agent's secrets at that level.","uniqueKey":"targets.items.[INDEX].secretScope","typeLabel":"enum\u003cstring>"},"hostPattern":{"type":"string","maxLength":1000,"description":"`network` targets.","uniqueKey":"targets.items.[INDEX].hostPattern","typeLabel":"string"},"pathPattern":{"oneOf":[{"type":"string","maxLength":1000,"uniqueKey":"targets.items.[INDEX].pathPattern.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1000,"uniqueKey":"targets.items.[INDEX].pathPattern.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].pathPattern","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE",null],"uniqueKey":"targets.items.[INDEX].method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["GET","POST","PUT","PATCH","DELETE",null],"uniqueKey":"targets.items.[INDEX].method.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].method","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"targets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"targets","typeLabel":"object[]"},"description":{"type":"string","maxLength":1000,"uniqueKey":"description","typeLabel":"string"},"enabled":{"type":"boolean","default":true,"uniqueKey":"enabled","typeLabel":"boolean"},"rateLimit":{"type":"integer","minimum":1,"maximum":1000000,"uniqueKey":"rateLimit","typeLabel":"integer"},"rateLimitWindow":{"type":"string","enum":["minute","hour","day"],"uniqueKey":"rateLimitWindow","typeLabel":"enum\u003cstring>"},"requireApproval":{"type":"boolean","uniqueKey":"requireApproval","typeLabel":"boolean"},"conditions":{"description":"A conditions array (max 10) or a session-policy object (`{repositories: [...]}` / `{folders: [...]}` / `{driveFolders: [...]}`; allow rules with a connection target only).","uniqueKey":"conditions","typeLabel":"any"},"identities":{"type":"array","maxItems":100,"items":{"type":"object","description":"A principal the rule applies to. Organization rules take `user`/`group` identities (`agent` exists at workspace scope only). An empty identity list means the rule applies to everyone. Targeting a `group` is an Enterprise feature.","required":["type","id"],"properties":{"type":{"type":"string","enum":["agent","user","group"],"isRequired":true,"uniqueKey":"identities.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"identities.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"identities","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","targets":[{"provider":"\u003cstring>","tools":["\u003cstring>"],"connectionId":"\u003cstring>","secretId":"\u003cstring>","hostPattern":"\u003cstring>","pathPattern":"\u003cstring>"}],"description":"\u003cstring>","enabled":true,"rateLimit":500000,"requireApproval":true,"conditions":"\u003cunknown>","identities":[{"id":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2aca8333-6781-4770-a6e2-a41feefdb1b8":{"description":"The rule","content":{"application/json":{"schema":{"type":"object","description":"A policy-engine rule. Every write is enforced immediately; the draft/published split survives only for older clients. Published row `id`s regenerate on every publish; `logicalId` is the identity stable across statuses and generations.","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"scope":{"type":"string","enum":["organization","workspace"],"uniqueKey":"scope","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["draft","published"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"generation":{"type":"integer","description":"0 for the draft working copy; the snapshot number for published rows.","uniqueKey":"generation","typeLabel":"integer"},"priority":{"type":"integer","description":"First-match order (lower evaluates first).","uniqueKey":"priority","typeLabel":"integer"},"enabled":{"type":"boolean","uniqueKey":"enabled","typeLabel":"boolean"},"isDefault":{"type":"boolean","description":"True on the scope's terminal Default Rule.","uniqueKey":"isDefault","typeLabel":"boolean"},"logicalId":{"type":"string","description":"Generation-stable identity; compare rules across draft/published by this, never by `id`.","uniqueKey":"logicalId","typeLabel":"string"},"source":{"type":"string","description":"`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).","uniqueKey":"source","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"action":{"type":"string","enum":["allow","block"],"uniqueKey":"action","typeLabel":"enum\u003cstring>"},"rateLimit":{"oneOf":[{"type":"integer","uniqueKey":"rateLimit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"rateLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"rateLimit","typeLabel":"integer | null"},"rateLimitWindow":{"oneOf":[{"type":"string","enum":["minute","hour","day",null],"uniqueKey":"rateLimitWindow.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["minute","hour","day",null],"uniqueKey":"rateLimitWindow.oneOf.1","typeLabel":"null"}],"uniqueKey":"rateLimitWindow","typeLabel":"enum\u003cstring> | null"},"requireApproval":{"type":"boolean","uniqueKey":"requireApproval","typeLabel":"boolean"},"conditions":{"oneOf":[{"description":"A conditions array, a session-policy object (`{repositories}` / `{folders}` / `{driveFolders}`), or null.","uniqueKey":"conditions.oneOf.0","typeLabel":"any"},{"description":"A conditions array, a session-policy object (`{repositories}` / `{folders}` / `{driveFolders}`), or null.","type":"null","uniqueKey":"conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"conditions","typeLabel":"any | null"},"identities":{"type":"array","items":{"type":"object","description":"A principal the rule applies to. Organization rules take `user`/`group` identities (`agent` exists at workspace scope only). An empty identity list means the rule applies to everyone. Targeting a `group` is an Enterprise feature.","required":["type","id"],"properties":{"type":{"type":"string","enum":["agent","user","group"],"isRequired":true,"uniqueKey":"identities.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"identities.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"identities","typeLabel":"object[]"},"targets":{"type":"array","items":{"type":"object","description":"One destination the rule matches, a discriminated union on `kind`: an `app` target (provider, optionally narrowed by `tools`), a `connection` target (`connectionId`, optional `tools`), a `secret` target (a specific `secretId` XOR a `secretScope` level), or a `network` target (host/path/method patterns). A rule needs at least one target.","required":["kind"],"properties":{"kind":{"type":"string","enum":["app","connection","secret","network"],"isRequired":true,"uniqueKey":"targets.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"`app` targets: the provider id (for example `gmail`).","uniqueKey":"targets.items.[INDEX].provider","typeLabel":"string"},"tools":{"type":"array","maxItems":100,"items":{"type":"string","uniqueKey":"targets.items.[INDEX].tools.items.[INDEX]","typeLabel":"string"},"description":"`app`/`connection` targets: narrow matching to these catalog tool ids; empty = the whole app.","uniqueKey":"targets.items.[INDEX].tools","typeLabel":"string[]"},"connectionScope":{"oneOf":[{"type":"string","enum":["organization","workspace"],"description":"`app` targets: set = inject all the agent's connections of the provider at that level; `null` (or omitted on write) = a block/allow layer with no injection.","uniqueKey":"targets.items.[INDEX].connectionScope.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["organization","workspace"],"description":"`app` targets: set = inject all the agent's connections of the provider at that level; `null` (or omitted on write) = a block/allow layer with no injection.","uniqueKey":"targets.items.[INDEX].connectionScope.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].connectionScope","typeLabel":"enum\u003cstring> | null"},"connectionId":{"type":"string","description":"`connection` targets: the connection id.","uniqueKey":"targets.items.[INDEX].connectionId","typeLabel":"string"},"secretId":{"type":"string","description":"`secret` targets: a specific secret (mutually exclusive with `secretScope`).","uniqueKey":"targets.items.[INDEX].secretId","typeLabel":"string"},"secretScope":{"type":"string","enum":["organization","workspace"],"description":"`secret` targets: all the agent's secrets at that level.","uniqueKey":"targets.items.[INDEX].secretScope","typeLabel":"enum\u003cstring>"},"hostPattern":{"type":"string","maxLength":1000,"description":"`network` targets.","uniqueKey":"targets.items.[INDEX].hostPattern","typeLabel":"string"},"pathPattern":{"oneOf":[{"type":"string","maxLength":1000,"uniqueKey":"targets.items.[INDEX].pathPattern.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1000,"uniqueKey":"targets.items.[INDEX].pathPattern.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].pathPattern","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE",null],"uniqueKey":"targets.items.[INDEX].method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["GET","POST","PUT","PATCH","DELETE",null],"uniqueKey":"targets.items.[INDEX].method.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].method","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"targets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"targets","typeLabel":"object[]"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","scope":"organization","status":"draft","generation":123,"priority":123,"enabled":true,"isDefault":true,"logicalId":"\u003cstring>","source":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","action":"allow","rateLimit":123,"rateLimitWindow":"minute","requireApproval":true,"conditions":"\u003cunknown>","identities":[{"type":"agent","id":"\u003cstring>"}],"targets":[{"kind":"app","provider":"\u003cstring>","tools":["\u003cstring>"],"connectionScope":"organization","connectionId":"\u003cstring>","secretId":"\u003cstring>","secretScope":"organization","hostPattern":"\u003cstring>","pathPattern":"\u003cstring>","method":"GET"}],"createdAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"04fe42c6-2b9c-47c5-827a-8c80e97d7398":{"description":"A plan-gated modifier (rate limit, group identity) on a plan without it (Cloud), or a group identity without the Enterprise entitlement (self-hosted)","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Error responses take one of two shapes depending on the failing layer: route-level validation returns the flat shape (`{ \"error\": \"...\" }`), while authentication failures and service errors return the envelope (`{ \"error\": { \"message\": \"...\", \"type\": \"...\" } }`).\n","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Error responses take one of two shapes depending on the failing layer: route-level validation returns the flat shape (`{ \"error\": \"...\" }`), while authentication failures and service errors return the envelope (`{ \"error\": { \"message\": \"...\", \"type\": \"...\" } }`).\n","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category: `authentication_error`, `invalid_request_error`, `not_found_error`, `validation_error`, `rate_limit_error`, `enterprise_license_required`, or `api_error`.","uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"code":{"type":"string","description":"Present on some `401`s (for example when the organization requires SSO).","uniqueKey":"oneOf.1.error.code","typeLabel":"string"}},"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"39130e61-397d-4cd0-bded-c673e1d1276c":{"description":"Validation error (unpaired `rateLimit`/`rateLimitWindow`, a modifier on a `block` rule, no targets, resource scoping without a connection target)","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Error responses take one of two shapes depending on the failing layer: route-level validation returns the flat shape (`{ \"error\": \"...\" }`), while authentication failures and service errors return the envelope (`{ \"error\": { \"message\": \"...\", \"type\": \"...\" } }`).\n","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Error responses take one of two shapes depending on the failing layer: route-level validation returns the flat shape (`{ \"error\": \"...\" }`), while authentication failures and service errors return the envelope (`{ \"error\": { \"message\": \"...\", \"type\": \"...\" } }`).\n","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category: `authentication_error`, `invalid_request_error`, `not_found_error`, `validation_error`, `rate_limit_error`, `enterprise_license_required`, or `api_error`.","uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"code":{"type":"string","description":"Present on some `401`s (for example when the organization requires SSO).","uniqueKey":"oneOf.1.error.code","typeLabel":"string"}},"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"60fa197f-31bd-4ed4-b029-08e7e575c688":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A workspace API key (`oc_…`) or organization API key (`oc_org_…`). Workspace-scoped endpoints called with an organization key also need `X-Workspace-Id`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"b3977aeb-de68-4d84-b6e0-fa89b0232679":{"url":"https://api.buckle.dev/v1","description":"Buckle Cloud"},"f6588b3c-095c-481a-8524-52287902fa98":{"url":"http://localhost:10254/v1","description":"Self-hosted"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A workspace API key (`oc_…`) or organization API key (`oc_org_…`). Workspace-scoped endpoints called with an organization key also need `X-Workspace-Id`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API key (`oc_…`) or organization API key (`oc_org_…`). Workspace-scoped endpoints called with an organization key also need `X-Workspace-Id`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"onecli-17d3f772","siteName":"Buckle","title":"Create an organization policy rule - Buckle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T13:33:53.822Z","originalFileLocation":"api-reference/organization-policy/create-an-organization-rule.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Buckle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an organization policy rule - Buckle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Buckle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onecli-17d3f772.mintlify.site/docs/_mintlify/api/og/v2?division=Policy\u0026amp;title=Create+an+organization+policy+rule\u0026amp;description=Adds+a+new+organization+policy+rule+just+above+the+Default+Rule.+The+rule+is+enforced+immediately+on+agent+requests+across+every+workspace.\u0026amp;theme=14ca75cbbb2a0e9ba5cd5703\u0026amp;signature=f9aed2345c271e80e5c02356f3e548beed903bfe4cc304d1406fd86ed86e3b11\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an organization policy rule - Buckle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onecli-17d3f772.mintlify.site/docs/_mintlify/api/og/v2?division=Policy\u0026amp;title=Create+an+organization+policy+rule\u0026amp;description=Adds+a+new+organization+policy+rule+just+above+the+Default+Rule.+The+rule+is+enforced+immediately+on+agent+requests+across+every+workspace.\u0026amp;theme=14ca75cbbb2a0e9ba5cd5703\u0026amp;signature=f9aed2345c271e80e5c02356f3e548beed903bfe4cc304d1406fd86ed86e3b11\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/onecli-17d3f772/eFiEtTXh_9JK0wwc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Buckle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff6a13\">\u003clink data-mint-head rel=\"canonical\" href=\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/organization-policy/create-an-organization-rule.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://onecli-17d3f772.mintlify.dev/#organization\",\"name\":\"Buckle\",\"url\":\"https://onecli-17d3f772.mintlify.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onecli-17d3f772/5_AFCR2UNaqNo0AT/logo/logo-full-light.svg?fit=max\u0026auto=format\u0026n=5_AFCR2UNaqNo0AT\u0026q=85\u0026s=30ceea1dd3505e0e9dea50b544521ced\"}},{\"@type\":\"WebSite\",\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs#website\",\"name\":\"Buckle\",\"url\":\"https://onecli-17d3f772.mintlify.dev/docs\",\"publisher\":{\"@id\":\"https://onecli-17d3f772.mintlify.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule#webpage\",\"url\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule\",\"name\":\"Create an organization policy rule\",\"description\":\"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.\",\"dateModified\":\"2026-11-15T13:33:53.822Z\",\"isPartOf\":{\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs#website\"},\"breadcrumb\":{\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Organization\",\"item\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization/get-the-current-organization\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Policy\",\"item\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create an organization policy rule\",\"item\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule#apireference\",\"headline\":\"Create an organization policy rule\",\"name\":\"Create an organization policy rule\",\"description\":\"Adds a new organization policy rule just above the Default Rule. The rule is enforced immediately on agent requests across every workspace.\",\"url\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule\",\"mainEntityOfPage\":{\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs/api-reference/organization-policy/create-an-organization-rule#webpage\"},\"dateModified\":\"2026-11-15T13:33:53.822Z\",\"publisher\":{\"@id\":\"https://onecli-17d3f772.mintlify.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://onecli-17d3f772.mintlify.dev/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Buckle\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Buckle\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/organization-policy/create-an-organization-rule.md","siteName":"Buckle","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"https://mintlify.s3.us-west-1.amazonaws.com/onecli-17d3f772/images/github.svg","href":"https://github.com/buckle"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"API Reference","groups":[{"group":"Overview","root":{"title":"API Reference: Authentication, Errors \u0026 Endpoints","sidebarTitle":"Overview","href":"/api-reference"},"pages":[{"title":"Editions and availability","sidebarTitle":"Editions","href":"/api-reference/editions"},{"title":"API Errors: Status Codes and Error Format","sidebarTitle":"Errors","href":"/api-reference/errors"},{"title":"Gateway Errors: Proxied Request Failures","sidebarTitle":"Gateway errors","href":"/api-reference/gateway-errors"},{"title":"Multiple Accounts: Gateway Selection Protocol","sidebarTitle":"Multiple accounts","href":"/api-reference/multi-account"},{"title":"Environment Variables","sidebarTitle":"Environment Variables","href":"/reference/environment-variables"},{"title":"Telemetry: What Buckle Collects and Where","sidebarTitle":"Telemetry","href":"/reference/telemetry"}]},{"group":"Workspace","pages":[{"group":"Workspaces","root":{"title":"Workspaces API: Partition Agents, Secrets, and Apps","sidebarTitle":"Overview","href":"/api-reference/workspaces"},"pages":[{"title":"List workspaces in your organization","deprecated":null,"version":null,"sidebarTitle":"List workspaces","openapi":"/openapi.yaml get /workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace in your organization","deprecated":null,"version":null,"sidebarTitle":"Create a workspace","openapi":"/openapi.yaml post /workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Get a workspace by ID","deprecated":null,"version":null,"sidebarTitle":"Get a workspace","openapi":"/openapi.yaml get /workspaces/{workspaceId}","href":"/api-reference/workspaces/get-a-workspace"},{"title":"Rename a workspace by ID","deprecated":null,"version":null,"sidebarTitle":"Rename a workspace","openapi":"/openapi.yaml patch /workspaces/{workspaceId}","href":"/api-reference/workspaces/rename-a-workspace"},{"title":"Delete a workspace and its contents","deprecated":null,"version":null,"sidebarTitle":"Delete a workspace","openapi":"/openapi.yaml delete /workspaces/{workspaceId}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"List pending channel approvals in a workspace","deprecated":null,"version":null,"sidebarTitle":"List pending channel approvals","openapi":"/openapi.yaml get /workspaces/{workspaceId}/channel-approvals","href":"/api-reference/workspaces/list-pending-channel-approvals"}]},{"group":"Agents","root":{"title":"Agents API: Create and Manage AI Agents","sidebarTitle":"Overview","href":"/api-reference/agents"},"pages":[{"title":"List agents in the current workspace","deprecated":null,"version":null,"sidebarTitle":"List agents","openapi":"/openapi.yaml get /agents","href":"/api-reference/agents/list-agents"},{"title":"Create an agent in the current workspace","deprecated":null,"version":null,"sidebarTitle":"Create an agent","openapi":"/openapi.yaml post /agents","href":"/api-reference/agents/create-an-agent"},{"title":"Get an agent and its hosted configuration","deprecated":null,"version":null,"sidebarTitle":"Get an agent","openapi":"/openapi.yaml get /agents/{agentId}","href":"/api-reference/agents/get-an-agent"},{"title":"Update an agent's name, brief, or model","deprecated":null,"version":null,"sidebarTitle":"Update an agent","openapi":"/openapi.yaml patch /agents/{agentId}","href":"/api-reference/agents/update-an-agent"},{"title":"Delete an agent and revoke its token","deprecated":null,"version":null,"sidebarTitle":"Delete an agent","openapi":"/openapi.yaml delete /agents/{agentId}","href":"/api-reference/agents/delete-an-agent"},{"title":"Regenerate an agent's gateway access token","deprecated":null,"version":null,"sidebarTitle":"Regenerate an agent's access token","openapi":"/openapi.yaml post /agents/{agentId}/regenerate-token","href":"/api-reference/agents/regenerate-an-agents-access-token"},{"title":"Restart a hosted agent's sandbox","deprecated":null,"version":null,"sidebarTitle":"Restart a hosted agent","openapi":"/openapi.yaml post /agents/{agentId}/restart","href":"/api-reference/agents/restart-a-hosted-agent"},{"title":"List the models an agent can use","deprecated":null,"version":null,"sidebarTitle":"List an agent's available models","openapi":"/openapi.yaml get /agents/{agentId}/models","href":"/api-reference/agents/list-an-agents-available-models"},{"title":"Upload an avatar image for an agent","deprecated":null,"version":null,"sidebarTitle":"Upload an agent's avatar","openapi":"/openapi.yaml put /agents/{agentId}/image","href":"/api-reference/agents/upload-an-agents-avatar"},{"title":"Remove an agent's avatar image","deprecated":null,"version":null,"sidebarTitle":"Remove an agent's avatar","openapi":"/openapi.yaml delete /agents/{agentId}/image","href":"/api-reference/agents/remove-an-agents-avatar"},{"title":"Open your direct conversation with an agent","deprecated":null,"version":null,"sidebarTitle":"Open your direct conversation with an agent","openapi":"/openapi.yaml put /agents/{agentId}/conversations/direct","href":"/api-reference/agents/open-your-direct-conversation-with-an-agent"},{"title":"Mint an SSH certificate for a hosted agent","deprecated":null,"version":null,"sidebarTitle":"Mint an SSH certificate for an agent","openapi":"/openapi.yaml post /agents/{agentId}/ssh-certificate","href":"/api-reference/agents/mint-an-ssh-certificate-for-an-agent"}]},{"group":"Grants","root":{"title":"Grants API: Control Which Credentials Agents Use","sidebarTitle":"Overview","href":"/api-reference/grants"},"pages":[{"title":"Get the connections and secrets granted to an agent","deprecated":null,"version":null,"sidebarTitle":"Get an agent's grants","openapi":"/openapi.yaml get /agents/{agentId}/grants","href":"/api-reference/grants/get-an-agents-grants"},{"title":"Attach an app connection to an agent","deprecated":null,"version":null,"sidebarTitle":"Attach a connection to an agent","openapi":"/openapi.yaml put /agents/{agentId}/grants/connections/{connectionId}","href":"/api-reference/grants/attach-a-connection-to-an-agent"},{"title":"Detach an app connection from an agent","deprecated":null,"version":null,"sidebarTitle":"Detach a connection from an agent","openapi":"/openapi.yaml delete /agents/{agentId}/grants/connections/{connectionId}","href":"/api-reference/grants/detach-a-connection-from-an-agent"},{"title":"Attach a secret to an agent","deprecated":null,"version":null,"sidebarTitle":"Attach a secret to an agent","openapi":"/openapi.yaml put /agents/{agentId}/grants/secrets/{secretId}","href":"/api-reference/grants/attach-a-secret-to-an-agent"},{"title":"Detach a secret from an agent","deprecated":null,"version":null,"sidebarTitle":"Detach a secret from an agent","openapi":"/openapi.yaml delete /agents/{agentId}/grants/secrets/{secretId}","href":"/api-reference/grants/detach-a-secret-from-an-agent"},{"title":"List the agents granted a connection","deprecated":null,"version":null,"sidebarTitle":"Get a connection's grants","openapi":"/openapi.yaml get /connections/{connectionId}/grants","href":"/api-reference/grants/get-a-connections-grants"},{"title":"Grant an agent access to a connection","deprecated":null,"version":null,"sidebarTitle":"Attach an agent to a connection","openapi":"/openapi.yaml put /connections/{connectionId}/grants/agents/{agentId}","href":"/api-reference/grants/attach-an-agent-to-a-connection"},{"title":"Revoke an agent's access to a connection","deprecated":null,"version":null,"sidebarTitle":"Detach an agent from a connection","openapi":"/openapi.yaml delete /connections/{connectionId}/grants/agents/{agentId}","href":"/api-reference/grants/detach-an-agent-from-a-connection"}]},{"group":"Secrets","root":{"title":"Secrets API: Store Credentials the Gateway Injects","sidebarTitle":"Overview","href":"/api-reference/secrets"},"pages":[{"title":"List secrets in the current workspace","deprecated":null,"version":null,"sidebarTitle":"List secrets","openapi":"/openapi.yaml get /secrets","href":"/api-reference/secrets/list-secrets"},{"title":"Create a secret for credential injection","deprecated":null,"version":null,"sidebarTitle":"Create a secret","openapi":"/openapi.yaml post /secrets","href":"/api-reference/secrets/create-a-secret"},{"title":"Update a workspace secret","deprecated":null,"version":null,"sidebarTitle":"Update a secret","openapi":"/openapi.yaml patch /secrets/{secretId}","href":"/api-reference/secrets/update-a-secret"},{"title":"Delete a workspace secret and its grants","deprecated":null,"version":null,"sidebarTitle":"Delete a secret","openapi":"/openapi.yaml delete /secrets/{secretId}","href":"/api-reference/secrets/delete-a-secret"}]},{"group":"Apps","root":{"title":"Apps API: Connect Apps and Configure OAuth Clients","sidebarTitle":"Overview","href":"/api-reference/apps"},"pages":[{"title":"List apps in the integration catalog","deprecated":null,"version":null,"sidebarTitle":"List apps","openapi":"/openapi.yaml get /apps","href":"/api-reference/apps/list-apps"},{"title":"List apps with a configured OAuth client","deprecated":null,"version":null,"sidebarTitle":"List configured apps","openapi":"/openapi.yaml get /apps/configured","href":"/api-reference/apps/list-configured-apps"},{"title":"Get the app allowlist for this workspace","deprecated":null,"version":null,"sidebarTitle":"Get the app allowlist for this workspace","openapi":"/openapi.yaml get /apps/available","href":"/api-reference/apps/get-the-app-allowlist-for-this-workspace"},{"title":"List apps with platform-provided OAuth clients","deprecated":null,"version":null,"sidebarTitle":"List apps with platform-provided OAuth clients","openapi":"/openapi.yaml get /apps/env-defaults","href":"/api-reference/apps/list-apps-with-platform-provided-oauth-clients"},{"title":"List every app's tool catalog","deprecated":null,"version":null,"sidebarTitle":"List every app's tool catalog","openapi":"/openapi.yaml get /apps/permission-definitions","href":"/api-reference/apps/list-every-apps-tool-catalog"},{"title":"Get an app and its connections","deprecated":null,"version":null,"sidebarTitle":"Get an app","openapi":"/openapi.yaml get /apps/{provider}","href":"/api-reference/apps/get-an-app"},{"title":"Get an app's tool catalog","deprecated":null,"version":null,"sidebarTitle":"Get an app's tool catalog","openapi":"/openapi.yaml get /apps/{provider}/permission-definition","href":"/api-reference/apps/get-an-apps-tool-catalog"},{"title":"Start an OAuth connect flow for an app","deprecated":null,"version":null,"sidebarTitle":"Start an OAuth connect","openapi":"/openapi.yaml get /apps/{provider}/authorize","href":"/api-reference/apps/start-an-oauth-connect"},{"title":"Connect an app with API key credentials","deprecated":null,"version":null,"sidebarTitle":"Connect an app with credentials","openapi":"/openapi.yaml post /apps/{provider}/connect","href":"/api-reference/apps/connect-an-app-with-credentials"},{"title":"Get an app's OAuth client configuration","deprecated":null,"version":null,"sidebarTitle":"Get an app's OAuth client configuration","openapi":"/openapi.yaml get /apps/{provider}/config","href":"/api-reference/apps/get-an-apps-oauth-client-configuration"},{"title":"Set an app's OAuth client configuration","deprecated":null,"version":null,"sidebarTitle":"Set an app's OAuth client configuration","openapi":"/openapi.yaml post /apps/{provider}/config","href":"/api-reference/apps/set-an-apps-oauth-client-configuration"},{"title":"Remove an app's OAuth client configuration","deprecated":null,"version":null,"sidebarTitle":"Remove an app's OAuth client configuration","openapi":"/openapi.yaml delete /apps/{provider}/config","href":"/api-reference/apps/remove-an-apps-oauth-client-configuration"},{"title":"Enable or disable an app's OAuth client","deprecated":null,"version":null,"sidebarTitle":"Enable or disable an app's OAuth client configuration","openapi":"/openapi.yaml patch /apps/{provider}/config/toggle","href":"/api-reference/apps/enable-or-disable-an-apps-oauth-client-configuration"},{"title":"Get an app's host blocklist state","deprecated":null,"version":null,"sidebarTitle":"Get an app's blocklist state","openapi":"/openapi.yaml get /apps/{provider}/blocklist","href":"/api-reference/apps/get-an-apps-blocklist-state"},{"title":"Block one of an app's predefined hosts","deprecated":null,"version":null,"sidebarTitle":"Block one of an app's hosts","openapi":"/openapi.yaml post /apps/{provider}/blocklist","href":"/api-reference/apps/block-one-of-an-apps-hosts"},{"title":"Enable or disable an app blocklist entry","deprecated":null,"version":null,"sidebarTitle":"Enable or disable a blocklist entry","openapi":"/openapi.yaml patch /apps/{provider}/blocklist/{ruleId}","href":"/api-reference/apps/enable-or-disable-a-blocklist-entry"},{"title":"Remove an app blocklist entry","deprecated":null,"version":null,"sidebarTitle":"Remove a blocklist entry","openapi":"/openapi.yaml delete /apps/{provider}/blocklist/{ruleId}","href":"/api-reference/apps/remove-a-blocklist-entry"}]},{"group":"Connections","root":{"title":"Connections API: Manage Connected App Accounts","sidebarTitle":"Overview","href":"/api-reference/connections"},"pages":[{"title":"List app connections in a workspace","deprecated":null,"version":null,"sidebarTitle":"List connections","openapi":"/openapi.yaml get /connections","href":"/api-reference/connections/list-connections"},{"title":"Rename an app connection","deprecated":null,"version":null,"sidebarTitle":"Rename a connection","openapi":"/openapi.yaml patch /connections/{connectionId}","href":"/api-reference/connections/rename-a-connection"},{"title":"Disconnect an app connection","deprecated":null,"version":null,"sidebarTitle":"Disconnect","openapi":"/openapi.yaml delete /connections/{connectionId}","href":"/api-reference/connections/disconnect"}]},{"group":"Effective policy","root":{"title":"Effective policy API: See What Agents Can Really Do","sidebarTitle":"Overview","href":"/api-reference/effective-policy"},"pages":[{"title":"Get effective app permissions in a workspace","deprecated":null,"version":null,"sidebarTitle":"Effective app permissions (workspace)","openapi":"/openapi.yaml get /policy/effective-app-permissions","href":"/api-reference/effective-policy/effective-app-permissions-workspace"},{"title":"Get an agent's effective credentials","deprecated":null,"version":null,"sidebarTitle":"Effective credentials of an agent","openapi":"/openapi.yaml get /agents/{agentId}/effective-credentials","href":"/api-reference/effective-policy/effective-credentials-of-an-agent"},{"title":"Get effective agent access to a connection","deprecated":null,"version":null,"sidebarTitle":"Effective agent access to a connection","openapi":"/openapi.yaml get /connections/{connectionId}/effective-agents","href":"/api-reference/effective-policy/effective-agent-access-to-a-connection"}]},{"group":"Conversations","root":{"title":"Conversations API: Talk to Hosted Agents","sidebarTitle":"Overview","href":"/api-reference/conversations"},"pages":[{"title":"List conversations in a workspace","deprecated":null,"version":null,"sidebarTitle":"List conversations","openapi":"/openapi.yaml get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Start a conversation with a hosted agent","deprecated":null,"version":null,"sidebarTitle":"Start a conversation","openapi":"/openapi.yaml post /conversations","href":"/api-reference/conversations/start-a-conversation"},{"title":"Get a conversation by ID","deprecated":null,"version":null,"sidebarTitle":"Get a conversation","openapi":"/openapi.yaml get /conversations/{conversationId}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List turns in a conversation","deprecated":null,"version":null,"sidebarTitle":"List turns","openapi":"/openapi.yaml get /conversations/{conversationId}/turns","href":"/api-reference/conversations/list-turns"},{"title":"Send a message as a new turn (strict)","deprecated":null,"version":null,"sidebarTitle":"Send a message (strict)","openapi":"/openapi.yaml post /conversations/{conversationId}/turns","href":"/api-reference/conversations/send-a-message-strict"},{"title":"Send a message to an agent conversation","deprecated":null,"version":null,"sidebarTitle":"Send a message","openapi":"/openapi.yaml post /conversations/{conversationId}/messages","href":"/api-reference/conversations/send-a-message"},{"title":"Read a conversation transcript","deprecated":null,"version":null,"sidebarTitle":"Read the transcript","openapi":"/openapi.yaml get /conversations/{conversationId}/events","href":"/api-reference/conversations/read-the-transcript"},{"title":"Stream a conversation transcript with SSE","deprecated":null,"version":null,"sidebarTitle":"Stream the transcript","openapi":"/openapi.yaml get /conversations/{conversationId}/stream","href":"/api-reference/conversations/stream-the-transcript"},{"title":"Upload a file attachment to a conversation","deprecated":null,"version":null,"sidebarTitle":"Upload an attachment","openapi":"/openapi.yaml post /conversations/{conversationId}/attachments","href":"/api-reference/conversations/upload-an-attachment"},{"title":"Download a conversation attachment","deprecated":null,"version":null,"sidebarTitle":"Download an attachment","openapi":"/openapi.yaml get /conversations/{conversationId}/attachments/{attachmentId}","href":"/api-reference/conversations/download-an-attachment"},{"title":"Get conversation attachment metadata","deprecated":null,"version":null,"sidebarTitle":"Get an attachment's metadata","openapi":"/openapi.yaml get /conversations/{conversationId}/attachments/{attachmentId}/meta","href":"/api-reference/conversations/get-an-attachments-metadata"},{"title":"Get a short-lived attachment download URL","deprecated":null,"version":null,"sidebarTitle":"Get a short-lived download URL","openapi":"/openapi.yaml get /conversations/{conversationId}/attachments/{attachmentId}/download-url","href":"/api-reference/conversations/get-a-short-lived-download-url"},{"title":"Abort a running conversation turn","deprecated":null,"version":null,"sidebarTitle":"Abort a turn","openapi":"/openapi.yaml post /turns/{turnId}/abort","href":"/api-reference/conversations/abort-a-turn"}]},{"group":"Schedules","root":{"title":"Schedules API: Run Hosted Agents on a Cron","sidebarTitle":"Overview","href":"/api-reference/schedules"},"pages":[{"title":"List an agent's scheduled prompts","deprecated":null,"version":null,"sidebarTitle":"List an agent's schedules","openapi":"/openapi.yaml get /agents/{agentId}/crons","href":"/api-reference/schedules/list-an-agents-schedules"},{"title":"Create a schedule for a hosted agent","deprecated":null,"version":null,"sidebarTitle":"Create a schedule","openapi":"/openapi.yaml post /agents/{agentId}/crons","href":"/api-reference/schedules/create-a-schedule"},{"title":"Update, pause, or resume an agent schedule","deprecated":null,"version":null,"sidebarTitle":"Update, pause, or resume a schedule","openapi":"/openapi.yaml patch /agents/{agentId}/crons/{cronId}","href":"/api-reference/schedules/update-pause-or-resume-a-schedule"},{"title":"Delete an agent schedule","deprecated":null,"version":null,"sidebarTitle":"Delete a schedule","openapi":"/openapi.yaml delete /agents/{agentId}/crons/{cronId}","href":"/api-reference/schedules/delete-a-schedule"},{"title":"Run an agent schedule now","deprecated":null,"version":null,"sidebarTitle":"Run a schedule now","openapi":"/openapi.yaml post /agents/{agentId}/crons/{cronId}/run","href":"/api-reference/schedules/run-a-schedule-now"}]},{"group":"Memories","root":{"title":"Memories API: Manage Hosted Agent Memory","sidebarTitle":"Overview","href":"/api-reference/memories"},"pages":[{"title":"List or search an agent's memories","deprecated":null,"version":null,"sidebarTitle":"List or search an agent's memories","openapi":"/openapi.yaml get /agents/{agentId}/memories","href":"/api-reference/memories/list-or-search-an-agents-memories"},{"title":"Create a memory for an agent","deprecated":null,"version":null,"sidebarTitle":"Create a memory","openapi":"/openapi.yaml post /agents/{agentId}/memories","href":"/api-reference/memories/create-a-memory"},{"title":"Get an agent memory by ID","deprecated":null,"version":null,"sidebarTitle":"Get a memory","openapi":"/openapi.yaml get /agents/{agentId}/memories/{memoryId}","href":"/api-reference/memories/get-a-memory"},{"title":"Update an agent memory","deprecated":null,"version":null,"sidebarTitle":"Update a memory","openapi":"/openapi.yaml patch /agents/{agentId}/memories/{memoryId}","href":"/api-reference/memories/update-a-memory"},{"title":"Delete an agent memory","deprecated":null,"version":null,"sidebarTitle":"Delete a memory","openapi":"/openapi.yaml delete /agents/{agentId}/memories/{memoryId}","href":"/api-reference/memories/delete-a-memory"},{"title":"List revisions of an agent memory","deprecated":null,"version":null,"sidebarTitle":"List a memory's revisions","openapi":"/openapi.yaml get /agents/{agentId}/memories/{memoryId}/revisions","href":"/api-reference/memories/list-a-memorys-revisions"},{"title":"Get a memory revision by ID","deprecated":null,"version":null,"sidebarTitle":"Get a revision","openapi":"/openapi.yaml get /agents/{agentId}/memories/{memoryId}/revisions/{revisionId}","href":"/api-reference/memories/get-a-revision"},{"title":"Restore a memory to an earlier revision","deprecated":null,"version":null,"sidebarTitle":"Restore a revision","openapi":"/openapi.yaml post /agents/{agentId}/memories/{memoryId}/revisions/{revisionId}/restore","href":"/api-reference/memories/restore-a-revision"},{"title":"Redact a memory revision","deprecated":null,"version":null,"sidebarTitle":"Redact a revision","openapi":"/openapi.yaml post /agents/{agentId}/memories/{memoryId}/revisions/{revisionId}/redact","href":"/api-reference/memories/redact-a-revision"}]},{"group":"Skills","root":{"title":"Skills API: Manage Workspace and Agent Skills","sidebarTitle":"Overview","href":"/api-reference/skills"},"pages":[{"title":"List skills available in a workspace","deprecated":null,"version":null,"sidebarTitle":"List skills","openapi":"/openapi.yaml get /skills","href":"/api-reference/skills/list-skills"},{"title":"Create a workspace or agent skill","deprecated":null,"version":null,"sidebarTitle":"Create a skill","openapi":"/openapi.yaml post /skills","href":"/api-reference/skills/create-a-skill"},{"title":"Get a skill with its body and files","deprecated":null,"version":null,"sidebarTitle":"Get a skill","openapi":"/openapi.yaml get /skills/{skillId}","href":"/api-reference/skills/get-a-skill"},{"title":"Update a workspace or agent skill","deprecated":null,"version":null,"sidebarTitle":"Update a skill","openapi":"/openapi.yaml patch /skills/{skillId}","href":"/api-reference/skills/update-a-skill"},{"title":"Delete a workspace or agent skill","deprecated":null,"version":null,"sidebarTitle":"Delete a skill","openapi":"/openapi.yaml delete /skills/{skillId}","href":"/api-reference/skills/delete-a-skill"}]},{"group":"Channels","root":{"title":"Channels API: Connect Hosted Agents to Slack","sidebarTitle":"Overview","href":"/api-reference/channels"},"pages":[{"title":"Get an agent's channel setup","deprecated":null,"version":null,"sidebarTitle":"Get an agent's channels","openapi":"/openapi.yaml get /agents/{agentId}/channels","href":"/api-reference/channels/get-an-agents-channels"},{"title":"Get the setup manifest for an agent channel","deprecated":null,"version":null,"sidebarTitle":"Get the setup material for a channel","openapi":"/openapi.yaml get /agents/{agentId}/channels/{provider}/manifest","href":"/api-reference/channels/get-the-setup-material-for-a-channel"},{"title":"Attach a channel to an agent (guided)","deprecated":null,"version":null,"sidebarTitle":"Attach a channel (guided)","openapi":"/openapi.yaml post /agents/{agentId}/channels/{provider}","href":"/api-reference/channels/attach-a-channel-guided"},{"title":"Detach a channel from an agent","deprecated":null,"version":null,"sidebarTitle":"Detach a channel","openapi":"/openapi.yaml delete /agents/{agentId}/channels/{provider}","href":"/api-reference/channels/detach-a-channel"},{"title":"Complete a channel attach with pasted tokens","deprecated":null,"version":null,"sidebarTitle":"Complete a channel attach with pasted tokens","openapi":"/openapi.yaml post /agents/{agentId}/channels/{provider}/complete","href":"/api-reference/channels/complete-a-channel-attach-with-pasted-tokens"},{"title":"Decide who may reach an agent in a space","deprecated":null,"version":null,"sidebarTitle":"Decide who may reach the agent in a space","openapi":"/openapi.yaml put /agents/{agentId}/channels/{provider}/reach/{externalRef}","href":"/api-reference/channels/decide-who-may-reach-the-agent-in-a-space"},{"title":"Forget an agent's channel space","deprecated":null,"version":null,"sidebarTitle":"Forget a space","openapi":"/openapi.yaml delete /agents/{agentId}/channels/{provider}/reach/{externalRef}","href":"/api-reference/channels/forget-a-space"},{"title":"Decide whether a person may reach an agent","deprecated":null,"version":null,"sidebarTitle":"Decide whether a person may reach the agent","openapi":"/openapi.yaml put /agents/{agentId}/channels/{provider}/reach/people/{externalRef}","href":"/api-reference/channels/decide-whether-a-person-may-reach-the-agent"},{"title":"Forget a person's channel reach decision","deprecated":null,"version":null,"sidebarTitle":"Forget a person","openapi":"/openapi.yaml delete /agents/{agentId}/channels/{provider}/reach/people/{externalRef}","href":"/api-reference/channels/forget-a-person"},{"title":"List an agent's action approvals","deprecated":null,"version":null,"sidebarTitle":"List an agent's action approvals","openapi":"/openapi.yaml get /agents/{agentId}/approvals","href":"/api-reference/channels/list-an-agents-action-approvals"},{"title":"Approve or reject an agent action","deprecated":null,"version":null,"sidebarTitle":"Decide an action approval","openapi":"/openapi.yaml post /agents/{agentId}/approvals/{approvalId}/decision","href":"/api-reference/channels/decide-an-action-approval"},{"title":"List an agent's outbound contacts","deprecated":null,"version":null,"sidebarTitle":"List an agent's contacts","openapi":"/openapi.yaml get /agents/{agentId}/contacts","href":"/api-reference/channels/list-an-agents-contacts"},{"title":"Set an agent contact's messaging policy","deprecated":null,"version":null,"sidebarTitle":"Set a contact's policy","openapi":"/openapi.yaml put /agents/{agentId}/contacts/{contactId}","href":"/api-reference/channels/set-a-contacts-policy"},{"title":"Remove a contact from an agent","deprecated":null,"version":null,"sidebarTitle":"Remove a contact","openapi":"/openapi.yaml delete /agents/{agentId}/contacts/{contactId}","href":"/api-reference/channels/remove-a-contact"},{"title":"List an agent's peer agents","deprecated":null,"version":null,"sidebarTitle":"List an agent's peers","openapi":"/openapi.yaml get /agents/{agentId}/links","href":"/api-reference/channels/list-an-agents-peers"},{"title":"Set an agent's side of a peer link","deprecated":null,"version":null,"sidebarTitle":"Set this agent's side of a peer link","openapi":"/openapi.yaml put /agents/{agentId}/links/{peerAgentId}","href":"/api-reference/channels/set-this-agents-side-of-a-peer-link"},{"title":"Forget an agent's peer link","deprecated":null,"version":null,"sidebarTitle":"Forget a peer","openapi":"/openapi.yaml delete /agents/{agentId}/links/{peerAgentId}","href":"/api-reference/channels/forget-a-peer"},{"title":"Resume a paused agent pair conversation","deprecated":null,"version":null,"sidebarTitle":"Resume a paused pair conversation","openapi":"/openapi.yaml post /agents/{agentId}/links/{peerAgentId}/resume","href":"/api-reference/channels/resume-a-paused-pair-conversation"}]},{"group":"Approvals","root":{"title":"Approvals API: Approve or Deny Agent Requests","sidebarTitle":"Overview","href":"/api-reference/approvals"},"pages":[{"title":"List pending manual approvals in a workspace","deprecated":null,"version":null,"sidebarTitle":"List pending approvals","openapi":"/openapi.yaml get /approvals/pending","href":"/api-reference/approvals/list-pending-approvals"},{"title":"Approve or deny a gateway request","deprecated":null,"version":null,"sidebarTitle":"Submit an approval decision","openapi":"/openapi.yaml post /approvals/{id}/decision","href":"/api-reference/approvals/submit-an-approval-decision"}]}]},{"group":"Organization","pages":[{"group":"Organization","root":{"title":"Organization API: Read Your Org and Manage Invitations","sidebarTitle":"Overview","href":"/api-reference/organization"},"pages":[{"title":"Get the current organization","deprecated":null,"version":null,"sidebarTitle":"Get the current organization","openapi":"/openapi.yaml get /org","href":"/api-reference/organization/get-the-current-organization"}]},{"group":"Invitations","pages":[{"title":"List pending organization invitations","deprecated":null,"version":null,"sidebarTitle":"List pending invitations","openapi":"/openapi.yaml get /org/invitations","href":"/api-reference/organization/list-pending-invitations"},{"title":"Invite someone to your organization","deprecated":null,"version":null,"sidebarTitle":"Invite someone","openapi":"/openapi.yaml post /org/invitations","href":"/api-reference/organization/invite-someone"},{"title":"Cancel a pending organization invitation","deprecated":null,"version":null,"sidebarTitle":"Cancel an invitation","openapi":"/openapi.yaml delete /org/invitations/{id}","href":"/api-reference/organization/cancel-an-invitation"},{"title":"Accept an organization invitation","deprecated":null,"version":null,"sidebarTitle":"Accept an invitation","openapi":"/openapi.yaml post /invitations/accept","href":"/api-reference/organization/accept-an-invitation"}]},{"group":"Secrets","root":{"title":"Organization secrets API: Share Keys Across Workspaces","sidebarTitle":"Overview","href":"/api-reference/organization-secrets"},"pages":[{"title":"List organization secrets","deprecated":null,"version":null,"sidebarTitle":"List organization secrets","openapi":"/openapi.yaml get /org/secrets","href":"/api-reference/organization-secrets/list-organization-secrets"},{"title":"Create an organization secret","deprecated":null,"version":null,"sidebarTitle":"Create an organization secret","openapi":"/openapi.yaml post /org/secrets","href":"/api-reference/organization-secrets/create-an-organization-secret"},{"title":"Update an organization secret","deprecated":null,"version":null,"sidebarTitle":"Update an organization secret","openapi":"/openapi.yaml patch /org/secrets/{secretId}","href":"/api-reference/organization-secrets/update-an-organization-secret"},{"title":"Delete an organization secret","deprecated":null,"version":null,"sidebarTitle":"Delete an organization secret","openapi":"/openapi.yaml delete /org/secrets/{secretId}","href":"/api-reference/organization-secrets/delete-an-organization-secret"}]},{"group":"Policy","root":{"title":"Organization Policy API: Rules That Bind Every Workspace","sidebarTitle":"Overview","href":"/api-reference/organization-policy"},"pages":[{"title":"List organization policy rules","description":"Returns your organization's policy rules in first-match order, with the Default Rule last. Requires the admin or owner role to read the rule set.","deprecated":null,"version":null,"sidebarTitle":"List organization rules","openapi":"/openapi.yaml get /org/policy/rules","href":"/api-reference/organization-policy/list-organization-rules"},{"title":"Create an organization policy rule","deprecated":null,"version":null,"sidebarTitle":"Create an organization rule","openapi":"/openapi.yaml post /org/policy/rules","href":"/api-reference/organization-policy/create-an-organization-rule"},{"title":"Reorder organization policy rules","description":"Sets the first-match order of organization rules. The list must name every non-default rule exactly once, and a stale list is rejected with a 409.","deprecated":null,"version":null,"sidebarTitle":"Reorder organization rules","openapi":"/openapi.yaml put /org/policy/rules/order","href":"/api-reference/organization-policy/reorder-organization-rules"},{"title":"Get an organization policy rule","deprecated":null,"version":null,"sidebarTitle":"Get an organization rule","openapi":"/openapi.yaml get /org/policy/rules/{ruleId}","href":"/api-reference/organization-policy/get-an-organization-rule"},{"title":"Update an organization policy rule","deprecated":null,"version":null,"sidebarTitle":"Update an organization rule","openapi":"/openapi.yaml patch /org/policy/rules/{ruleId}","href":"/api-reference/organization-policy/update-an-organization-rule"},{"title":"Delete an organization policy rule","deprecated":null,"version":null,"sidebarTitle":"Delete an organization rule","openapi":"/openapi.yaml delete /org/policy/rules/{ruleId}","href":"/api-reference/organization-policy/delete-an-organization-rule"},{"title":"Get the organization Default Rule","deprecated":null,"version":null,"sidebarTitle":"Get the organization's Default Rule","openapi":"/openapi.yaml get /org/policy/default","href":"/api-reference/organization-policy/get-the-organizations-default-rule"},{"title":"Set the organization default policy action","deprecated":null,"version":null,"sidebarTitle":"Set the organization's default action","openapi":"/openapi.yaml patch /org/policy/default","href":"/api-reference/organization-policy/set-the-organizations-default-action"},{"title":"Publish organization policy rules","deprecated":true,"version":null,"sidebarTitle":"Publish the organization's rules","openapi":"/openapi.yaml post /org/policy/publish","href":"/api-reference/organization-policy/publish-the-organizations-rules"},{"title":"Get the latest organization policy publish","deprecated":true,"version":null,"sidebarTitle":"Get the most recent publish","openapi":"/openapi.yaml get /org/policy/last-publish","href":"/api-reference/organization-policy/get-the-most-recent-publish"},{"title":"Get effective org app permissions","deprecated":null,"version":null,"sidebarTitle":"Effective app permissions (organization)","openapi":"/openapi.yaml get /org/policy/effective-app-permissions","href":"/api-reference/organization-policy/effective-app-permissions-organization"}]},{"group":"Connections","root":{"title":"Organization Connections API: Apps Shared Across Workspaces","sidebarTitle":"Overview","href":"/api-reference/organization-connections"},"pages":[{"title":"List organization app connections","deprecated":null,"version":null,"sidebarTitle":"List organization connections","openapi":"/openapi.yaml get /org/connections","href":"/api-reference/organization-connections/list-organization-connections"},{"title":"Rename an organization app connection","deprecated":null,"version":null,"sidebarTitle":"Rename an organization connection","openapi":"/openapi.yaml patch /org/connections/{connectionId}","href":"/api-reference/organization-connections/rename-an-organization-connection"},{"title":"Disconnect an organization app connection","deprecated":null,"version":null,"sidebarTitle":"Disconnect an organization connection","openapi":"/openapi.yaml delete /org/connections/{connectionId}","href":"/api-reference/organization-connections/disconnect-an-organization-connection"}]},{"group":"Apps","root":{"title":"Organization Apps API: Shared Connects and OAuth Clients","sidebarTitle":"Overview","href":"/api-reference/organization-apps"},"pages":[{"title":"Start an organization OAuth app connect","deprecated":null,"version":null,"sidebarTitle":"Start an organization-level OAuth connect","openapi":"/openapi.yaml get /org/apps/{provider}/authorize","href":"/api-reference/organization-apps/start-an-organization-level-oauth-connect"},{"title":"Connect an app for the whole organization","deprecated":null,"version":null,"sidebarTitle":"Connect an app at the organization level","openapi":"/openapi.yaml post /org/apps/{provider}/connect","href":"/api-reference/organization-apps/connect-an-app-at-the-organization-level"},{"title":"Get the organization AWS external ID","deprecated":null,"version":null,"sidebarTitle":"Get the organization's AWS external ID","openapi":"/openapi.yaml get /org/apps/aws-external-id","href":"/api-reference/organization-apps/get-the-organizations-aws-external-id"},{"title":"List apps with org OAuth configuration","deprecated":null,"version":null,"sidebarTitle":"List organization-configured apps","openapi":"/openapi.yaml get /org/apps/configured","href":"/api-reference/organization-apps/list-organization-configured-apps"},{"title":"Get an organization app OAuth configuration","deprecated":null,"version":null,"sidebarTitle":"Get an organization app configuration","openapi":"/openapi.yaml get /org/apps/{provider}/config","href":"/api-reference/organization-apps/get-an-organization-app-configuration"},{"title":"Set an organization app OAuth configuration","deprecated":null,"version":null,"sidebarTitle":"Set an organization app configuration","openapi":"/openapi.yaml post /org/apps/{provider}/config","href":"/api-reference/organization-apps/set-an-organization-app-configuration"},{"title":"Remove an organization app OAuth config","deprecated":null,"version":null,"sidebarTitle":"Remove an organization app configuration","openapi":"/openapi.yaml delete /org/apps/{provider}/config","href":"/api-reference/organization-apps/remove-an-organization-app-configuration"},{"title":"Enable or disable an org app OAuth config","deprecated":null,"version":null,"sidebarTitle":"Enable or disable an organization app configuration","openapi":"/openapi.yaml patch /org/apps/{provider}/config/toggle","href":"/api-reference/organization-apps/enable-or-disable-an-organization-app-configuration"},{"title":"Get an app organization blocklist state","deprecated":null,"version":null,"sidebarTitle":"Get an app's organization blocklist state","openapi":"/openapi.yaml get /org/apps/{provider}/blocklist","href":"/api-reference/organization-apps/get-an-apps-organization-blocklist-state"},{"title":"Block an app host organization-wide","deprecated":null,"version":null,"sidebarTitle":"Block one of an app's hosts organization-wide","openapi":"/openapi.yaml post /org/apps/{provider}/blocklist","href":"/api-reference/organization-apps/block-one-of-an-apps-hosts-organization-wide"},{"title":"Enable or disable an org blocklist entry","deprecated":null,"version":null,"sidebarTitle":"Enable or disable an organization blocklist entry","openapi":"/openapi.yaml patch /org/apps/{provider}/blocklist/{ruleId}","href":"/api-reference/organization-apps/enable-or-disable-an-organization-blocklist-entry"},{"title":"Remove an organization blocklist entry","deprecated":null,"version":null,"sidebarTitle":"Remove an organization blocklist entry","openapi":"/openapi.yaml delete /org/apps/{provider}/blocklist/{ruleId}","href":"/api-reference/organization-apps/remove-an-organization-blocklist-entry"}]},{"group":"Skills","root":{"title":"Organization Skills API: Skills for Every Hosted Agent","sidebarTitle":"Overview","href":"/api-reference/organization-skills"},"pages":[{"title":"List organization skills","deprecated":null,"version":null,"sidebarTitle":"List organization skills","openapi":"/openapi.yaml get /org/skills","href":"/api-reference/organization-skills/list-organization-skills"},{"title":"Create an organization skill","deprecated":null,"version":null,"sidebarTitle":"Create an organization skill","openapi":"/openapi.yaml post /org/skills","href":"/api-reference/organization-skills/create-an-organization-skill"},{"title":"Get an organization skill","deprecated":null,"version":null,"sidebarTitle":"Get an organization skill","openapi":"/openapi.yaml get /org/skills/{skillId}","href":"/api-reference/organization-skills/get-an-organization-skill"},{"title":"Update an organization skill","deprecated":null,"version":null,"sidebarTitle":"Update an organization skill","openapi":"/openapi.yaml patch /org/skills/{skillId}","href":"/api-reference/organization-skills/update-an-organization-skill"},{"title":"Delete an organization skill","deprecated":null,"version":null,"sidebarTitle":"Delete an organization skill","openapi":"/openapi.yaml delete /org/skills/{skillId}","href":"/api-reference/organization-skills/delete-an-organization-skill"}]},{"group":"Channels","root":{"title":"Organization Channels API: Slack Integration and Identity","sidebarTitle":"Overview","href":"/api-reference/organization-channels"},"pages":[{"title":"Get organization channel integrations","deprecated":null,"version":null,"sidebarTitle":"Get the organization's channel integrations","openapi":"/openapi.yaml get /org/channels","href":"/api-reference/organization-channels/get-the-organizations-channel-integrations"},{"title":"Connect or refresh an org channel credential","deprecated":null,"version":null,"sidebarTitle":"Connect or refresh the organization's channel credential","openapi":"/openapi.yaml put /org/channels/{provider}/credentials","href":"/api-reference/organization-channels/connect-or-refresh-the-organizations-channel-credential"},{"title":"Disconnect an organization channel credential","deprecated":null,"version":null,"sidebarTitle":"Disconnect the organization's channel credential","openapi":"/openapi.yaml delete /org/channels/{provider}","href":"/api-reference/organization-channels/disconnect-the-organizations-channel-credential"},{"title":"Get the shared Slack app setup manifest","deprecated":null,"version":null,"sidebarTitle":"Get the shared-app setup manifest","openapi":"/openapi.yaml get /org/channels/{provider}/shared-manifest","href":"/api-reference/organization-channels/get-the-shared-app-setup-manifest"},{"title":"Start a shared Slack app install","deprecated":null,"version":null,"sidebarTitle":"Start a shared-app install","openapi":"/openapi.yaml post /org/channels/{provider}/shared-install","href":"/api-reference/organization-channels/start-a-shared-app-install"},{"title":"Disconnect the shared Slack app install","deprecated":null,"version":null,"sidebarTitle":"Disconnect the shared-app install","openapi":"/openapi.yaml delete /org/channels/{provider}/shared-install","href":"/api-reference/organization-channels/disconnect-the-shared-app-install"},{"title":"Inspect a marketplace install code","deprecated":null,"version":null,"sidebarTitle":"Inspect a marketplace install code","openapi":"/openapi.yaml post /org/channels/{provider}/finish-install/inspect","href":"/api-reference/organization-channels/inspect-a-marketplace-install-code"},{"title":"Finish a marketplace channel install","deprecated":null,"version":null,"sidebarTitle":"Finish a marketplace install","openapi":"/openapi.yaml post /org/channels/{provider}/finish-install","href":"/api-reference/organization-channels/finish-a-marketplace-install"},{"title":"Link a Slack identity to an org member","deprecated":null,"version":null,"sidebarTitle":"Link a provider identity to a member","openapi":"/openapi.yaml post /org/channels/{provider}/user-links","href":"/api-reference/organization-channels/link-a-provider-identity-to-a-member"},{"title":"Remove a channel identity link","deprecated":null,"version":null,"sidebarTitle":"Remove an identity link","openapi":"/openapi.yaml delete /org/channels/{provider}/user-links/{linkId}","href":"/api-reference/organization-channels/remove-an-identity-link"}]},{"group":"Approvals","root":{"title":"Organization Approvals API: Pending Requests Across Workspaces","sidebarTitle":"Overview","href":"/api-reference/organization-approvals"},"pages":[{"title":"List pending approvals across an organization","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List pending approvals across the organization","openapi":"/openapi.yaml get /org/approvals/pending","href":"/api-reference/organization-approvals/list-pending-approvals-across-the-organization"}]}]},{"group":"Enterprise","pages":[{"group":"Members","root":{"title":"Members API: Provision, Suspend, and Remove Members","sidebarTitle":"Overview","href":"/api-reference/members"},"pages":[{"title":"List organization members","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List members","openapi":"/openapi.yaml get /org/members","href":"/api-reference/members/list-members"},{"title":"Provision an organization member","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Provision a member","openapi":"/openapi.yaml post /org/members","href":"/api-reference/members/provision-a-member"},{"title":"Suspend, reinstate, or SSO-exempt a member","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Suspend, reinstate, or SSO-exempt a member","openapi":"/openapi.yaml patch /org/members/{userId}","href":"/api-reference/members/suspend-reinstate-or-sso-exempt-a-member"},{"title":"Remove a member from the organization","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Remove a member","openapi":"/openapi.yaml delete /org/members/{userId}","href":"/api-reference/members/remove-a-member"},{"title":"List groups for an organization member","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List a member's groups","openapi":"/openapi.yaml get /org/members/{userId}/groups","href":"/api-reference/members/list-a-members-groups"}]},{"group":"Groups and roles","root":{"title":"Groups API: Directory Groups and Role Mappings","sidebarTitle":"Overview","href":"/api-reference/groups"},"pages":[{"title":"List directory groups in an organization","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List groups","openapi":"/openapi.yaml get /org/groups","href":"/api-reference/groups/list-groups"},{"title":"Create a directory group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Create a group","openapi":"/openapi.yaml post /org/groups","href":"/api-reference/groups/create-a-group"},{"title":"Get a directory group by ID","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Get a group","openapi":"/openapi.yaml get /org/groups/{groupId}","href":"/api-reference/groups/get-a-group"},{"title":"Rename a directory group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Rename a group","openapi":"/openapi.yaml patch /org/groups/{groupId}","href":"/api-reference/groups/rename-a-group"},{"title":"Delete a directory group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Delete a group","openapi":"/openapi.yaml delete /org/groups/{groupId}","href":"/api-reference/groups/delete-a-group"},{"title":"List the members of a directory group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List a group's members","openapi":"/openapi.yaml get /org/groups/{groupId}/members","href":"/api-reference/groups/list-a-groups-members"},{"title":"Replace all members of a directory group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Replace a group's members","openapi":"/openapi.yaml put /org/groups/{groupId}/members","href":"/api-reference/groups/replace-a-groups-members"},{"title":"Add a user to a directory group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Add a member to a group","openapi":"/openapi.yaml put /org/groups/{groupId}/members/{userId}","href":"/api-reference/groups/add-a-member-to-a-group"},{"title":"Remove a user from a directory group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Remove a member from a group","openapi":"/openapi.yaml delete /org/groups/{groupId}/members/{userId}","href":"/api-reference/groups/remove-a-member-from-a-group"},{"title":"List group-to-role mappings","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List group-to-role mappings","openapi":"/openapi.yaml get /org/role-mappings","href":"/api-reference/groups/list-group-to-role-mappings"},{"title":"Create a group-to-role mapping","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Create a role mapping","openapi":"/openapi.yaml post /org/role-mappings","href":"/api-reference/groups/create-a-role-mapping"},{"title":"Reorder group-to-role mapping priority","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Reorder role mappings","openapi":"/openapi.yaml put /org/role-mappings/order","href":"/api-reference/groups/reorder-role-mappings"},{"title":"Preview the impact of a role mapping","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Preview a role mapping's impact","openapi":"/openapi.yaml post /org/role-mappings/preview","href":"/api-reference/groups/preview-a-role-mappings-impact"},{"title":"Update a group-to-role mapping","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Update a role mapping","openapi":"/openapi.yaml patch /org/role-mappings/{id}","href":"/api-reference/groups/update-a-role-mapping"},{"title":"Delete a group-to-role mapping","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Delete a role mapping","openapi":"/openapi.yaml delete /org/role-mappings/{id}","href":"/api-reference/groups/delete-a-role-mapping"}]},{"group":"Workspace access","root":{"title":"Workspace access API: Share Workspaces with Teams","sidebarTitle":"Overview","href":"/api-reference/workspace-access"},"pages":[{"title":"List who a workspace is shared with","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List who a workspace is shared with","openapi":"/openapi.yaml get /workspaces/{workspaceId}/access","href":"/api-reference/workspace-access/list-who-a-workspace-is-shared-with"},{"title":"Replace who a workspace is shared with","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Replace who a workspace is shared with","openapi":"/openapi.yaml put /workspaces/{workspaceId}/access","href":"/api-reference/workspace-access/replace-who-a-workspace-is-shared-with"}]},{"group":"Domains","root":{"title":"Domains API: Verify Email Domains for SSO","sidebarTitle":"Overview","href":"/api-reference/domains"},"pages":[{"title":"List verified domains for an organization","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List verified domains","openapi":"/openapi.yaml get /org/domains","href":"/api-reference/domains/list-verified-domains"},{"title":"Add an email domain to an organization","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Add a domain","openapi":"/openapi.yaml post /org/domains","href":"/api-reference/domains/add-a-domain"},{"title":"Verify domain ownership with a DNS TXT record","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Verify a domain","openapi":"/openapi.yaml post /org/domains/{domainId}/verify","href":"/api-reference/domains/verify-a-domain"},{"title":"Remove a domain from an organization","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Remove a domain","openapi":"/openapi.yaml delete /org/domains/{domainId}","href":"/api-reference/domains/remove-a-domain"}]},{"group":"SSO","root":{"title":"SSO API: SAML and OIDC Sign-in Connections","sidebarTitle":"Overview","href":"/api-reference/sso"},"pages":[{"title":"List SSO connections for an organization","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List SSO connections","openapi":"/openapi.yaml get /org/sso/connections","href":"/api-reference/sso/list-sso-connections"},{"title":"Create a SAML or OIDC SSO connection","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Create an SSO connection","openapi":"/openapi.yaml post /org/sso/connections","href":"/api-reference/sso/create-an-sso-connection"},{"title":"Update an SSO connection","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Update an SSO connection","openapi":"/openapi.yaml patch /org/sso/connections/{connectionId}","href":"/api-reference/sso/update-an-sso-connection"},{"title":"Delete an SSO connection","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Delete an SSO connection","openapi":"/openapi.yaml delete /org/sso/connections/{connectionId}","href":"/api-reference/sso/delete-an-sso-connection"},{"title":"Test an SSO connection configuration","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Test an SSO connection","openapi":"/openapi.yaml post /org/sso/connections/{connectionId}/test","href":"/api-reference/sso/test-an-sso-connection"},{"title":"Get the SSO enforcement status","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Get SSO enforcement","openapi":"/openapi.yaml get /org/sso/enforcement","href":"/api-reference/sso/get-sso-enforcement"},{"title":"Require or stop requiring SSO sign-in","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Require or stop requiring SSO","openapi":"/openapi.yaml patch /org/sso/enforcement","href":"/api-reference/sso/require-or-stop-requiring-sso"},{"title":"Look up the SSO setup for an email address","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Look up SSO for an email","openapi":"/openapi.yaml post /auth/sso/lookup","href":"/api-reference/sso/look-up-sso-for-an-email"}]},{"group":"SCIM tokens","root":{"title":"SCIM Tokens API: Credentials for Identity Provider Sync","sidebarTitle":"Overview","href":"/api-reference/scim-tokens"},"pages":[{"title":"List active SCIM provisioning tokens","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List SCIM tokens","openapi":"/openapi.yaml get /org/scim/tokens","href":"/api-reference/scim-tokens/list-scim-tokens"},{"title":"Create a SCIM provisioning token","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Create a SCIM token","openapi":"/openapi.yaml post /org/scim/tokens","href":"/api-reference/scim-tokens/create-a-scim-token"},{"title":"Revoke a SCIM provisioning token","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Revoke a SCIM token","openapi":"/openapi.yaml delete /org/scim/tokens/{tokenId}","href":"/api-reference/scim-tokens/revoke-a-scim-token"}]},{"group":"App availability","root":{"title":"App Availability API: Limit Which Apps Workspaces Connect","sidebarTitle":"Overview","href":"/api-reference/app-availability"},"pages":[{"title":"Get the organization app-availability policy","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Get the app-availability policy","openapi":"/openapi.yaml get /org/app-availability","href":"/api-reference/app-availability/get-the-app-availability-policy"},{"title":"Replace the app-availability policy","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Replace the app-availability policy","openapi":"/openapi.yaml put /org/app-availability","href":"/api-reference/app-availability/replace-the-app-availability-policy"}]},{"group":"Provisioning","root":{"title":"Provisioning API: Pre-create Members with Ready Workspaces","sidebarTitle":"Overview","href":"/api-reference/provisioning"},"pages":[{"title":"Provision a user before their first sign-in","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Provision a user","openapi":"/openapi.yaml post /team/provisions","href":"/api-reference/provisioning/provision-a-user"},{"title":"Claim a provisioned account","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Claim a provisioned account","openapi":"/openapi.yaml post /provisions/claim","href":"/api-reference/provisioning/claim-a-provisioned-account"}]},{"group":"Resource browsing","root":{"title":"Resource browsing API: Pick Folders for Grant Scopes","sidebarTitle":"Overview","href":"/api-reference/resource-browsing"},"pages":[{"title":"Browse a Dropbox connection's folders","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Browse a Dropbox connection's folders","openapi":"/openapi.yaml get /apps/dropbox/folders","href":"/api-reference/resource-browsing/browse-a-dropbox-connections-folders"},{"title":"Browse a Google Drive connection's folders","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Browse a Google Drive connection's folders","openapi":"/openapi.yaml get /apps/google-drive/folders","href":"/api-reference/resource-browsing/browse-a-google-drive-connections-folders"},{"title":"Resolve Google Drive folder IDs to names","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Resolve Google Drive folder names","openapi":"/openapi.yaml get /apps/google-drive/folder-names","href":"/api-reference/resource-browsing/resolve-google-drive-folder-names"}]},{"group":"SCIM 2.0","root":{"title":"SCIM API: Sync Users and Groups from Your IdP","sidebarTitle":"Overview","href":"/api-reference/scim"},"pages":[{"title":"List SCIM users with filtering","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List users","openapi":"/openapi.yaml get /Users","href":"/api-reference/scim/list-users"},{"title":"Create a user via SCIM provisioning","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Create a user","openapi":"/openapi.yaml post /Users","href":"/api-reference/scim/create-a-user"},{"title":"Get a SCIM user by ID","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Get a user","openapi":"/openapi.yaml get /Users/{id}","href":"/api-reference/scim/get-a-user"},{"title":"Replace a SCIM user's attributes","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Replace a user","openapi":"/openapi.yaml put /Users/{id}","href":"/api-reference/scim/replace-a-user"},{"title":"Partially update a SCIM user","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Patch a user","openapi":"/openapi.yaml patch /Users/{id}","href":"/api-reference/scim/patch-a-user"},{"title":"Delete a SCIM user (suspend membership)","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Delete a user","openapi":"/openapi.yaml delete /Users/{id}","href":"/api-reference/scim/delete-a-user"},{"title":"List SCIM groups with filtering","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"List groups","openapi":"/openapi.yaml get /Groups","href":"/api-reference/scim/list-groups"},{"title":"Create a group via SCIM provisioning","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Create a group","openapi":"/openapi.yaml post /Groups","href":"/api-reference/scim/create-a-group"},{"title":"Get a SCIM group by ID","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Get a group","openapi":"/openapi.yaml get /Groups/{id}","href":"/api-reference/scim/get-a-group"},{"title":"Replace a SCIM group and its members","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Replace a group","openapi":"/openapi.yaml put /Groups/{id}","href":"/api-reference/scim/replace-a-group"},{"title":"Partially update a SCIM group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Patch a group","openapi":"/openapi.yaml patch /Groups/{id}","href":"/api-reference/scim/patch-a-group"},{"title":"Delete a SCIM-managed group","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Delete a group","openapi":"/openapi.yaml delete /Groups/{id}","href":"/api-reference/scim/delete-a-group"},{"title":"Get the SCIM service provider config","deprecated":null,"version":null,"tag":"Enterprise","sidebarTitle":"Service provider configuration","openapi":"/openapi.yaml get /ServiceProviderConfig","href":"/api-reference/scim/service-provider-configuration"}]}]},{"group":"Platform","pages":[{"group":"User","root":{"title":"User API: Profile, API Keys, and SSH Keys","sidebarTitle":"Overview","href":"/api-reference/user"},"pages":[{"title":"Get your user profile","deprecated":null,"version":null,"sidebarTitle":"Get your profile","openapi":"/openapi.yaml get /user","href":"/api-reference/user/get-your-profile"},{"title":"Update your user profile","deprecated":null,"version":null,"sidebarTitle":"Update your profile","openapi":"/openapi.yaml patch /user","href":"/api-reference/user/update-your-profile"},{"title":"Delete your user account","deprecated":null,"version":null,"sidebarTitle":"Delete your account","openapi":"/openapi.yaml delete /user","href":"/api-reference/user/delete-your-account"},{"title":"Preview your account deletion impact","deprecated":null,"version":null,"sidebarTitle":"Preview account deletion","openapi":"/openapi.yaml get /user/deletion-impact","href":"/api-reference/user/preview-account-deletion"},{"title":"Get your personal workspace API key","deprecated":null,"version":null,"sidebarTitle":"Get your workspace API key","openapi":"/openapi.yaml get /user/api-key","href":"/api-reference/user/get-your-workspace-api-key"},{"title":"Regenerate your workspace API key","deprecated":null,"version":null,"sidebarTitle":"Regenerate your workspace API key","openapi":"/openapi.yaml post /user/api-key/regenerate","href":"/api-reference/user/regenerate-your-workspace-api-key"},{"title":"List your registered SSH keys","deprecated":null,"version":null,"sidebarTitle":"List your SSH keys","openapi":"/openapi.yaml get /user/ssh-keys","href":"/api-reference/user/list-your-ssh-keys"},{"title":"Register an SSH public key","deprecated":null,"version":null,"sidebarTitle":"Register an SSH key","openapi":"/openapi.yaml post /user/ssh-keys","href":"/api-reference/user/register-an-ssh-key"},{"title":"Remove an SSH key from your account","deprecated":null,"version":null,"sidebarTitle":"Remove an SSH key","openapi":"/openapi.yaml delete /user/ssh-keys/{keyId}","href":"/api-reference/user/remove-an-ssh-key"}]},{"group":"Instance","root":{"title":"Instance API: Deployment Facts and Gateway Setup","sidebarTitle":"Overview","href":"/api-reference/instance"},"pages":[{"title":"Check deployment health and liveness","deprecated":null,"version":null,"sidebarTitle":"Health check","openapi":"/openapi.yaml get /health","href":"/api-reference/instance/health-check"},{"title":"Get deployment edition and settings","deprecated":null,"version":null,"sidebarTitle":"Get deployment facts","openapi":"/openapi.yaml get /instance","href":"/api-reference/instance/get-deployment-facts"},{"title":"Get the deployment's egress IP addresses","deprecated":null,"version":null,"sidebarTitle":"Get the deployment's egress addresses","openapi":"/openapi.yaml get /instance/egress","href":"/api-reference/instance/get-the-deployments-egress-addresses"},{"title":"Get the gateway URL for this deployment","deprecated":null,"version":null,"sidebarTitle":"Get the gateway URL","openapi":"/openapi.yaml get /gateway-url","href":"/api-reference/instance/get-the-gateway-url"},{"title":"Download the gateway CA certificate","deprecated":null,"version":null,"sidebarTitle":"Download the gateway CA certificate","openapi":"/openapi.yaml get /gateway/ca","href":"/api-reference/instance/download-the-gateway-ca-certificate"}]},{"group":"Utility","root":{"title":"Utility API: Counts, Vaults, and Agent Bootstrap","sidebarTitle":"Overview","href":"/api-reference/utility"},"pages":[{"title":"Get resource counts for a workspace","deprecated":null,"version":null,"sidebarTitle":"Get resource counts","openapi":"/openapi.yaml get /counts","href":"/api-reference/utility/get-resource-counts"},{"title":"List external vault connections","deprecated":null,"version":null,"sidebarTitle":"List vault connections","openapi":"/openapi.yaml get /vaults","href":"/api-reference/utility/list-vault-connections"},{"title":"List hosted-agent runners","deprecated":null,"version":null,"sidebarTitle":"List runners","openapi":"/openapi.yaml get /runners","href":"/api-reference/utility/list-runners"},{"title":"Get an agent's container configuration","deprecated":null,"version":null,"sidebarTitle":"Get an agent's container configuration","openapi":"/openapi.yaml get /container-config","href":"/api-reference/utility/get-an-agents-container-configuration"},{"title":"List agents with credential stubs","deprecated":null,"version":null,"sidebarTitle":"List agents with credential stubs","openapi":"/openapi.yaml get /credential-stubs","href":"/api-reference/utility/list-agents-with-credential-stubs"},{"title":"Get a coding agent credential stub","deprecated":null,"version":null,"sidebarTitle":"Get a credential stub","openapi":"/openapi.yaml get /credential-stubs/{agent}","href":"/api-reference/utility/get-a-credential-stub"},{"title":"Get the gateway skill for coding agents","deprecated":null,"version":null,"sidebarTitle":"Get the gateway skill","openapi":"/openapi.yaml get /skill/gateway","href":"/api-reference/utility/get-the-gateway-skill"}]}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]}]},"basePath":"","title":"Create an organization policy rule - Buckle","buildId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","deploymentId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CQGbdtm4.js","utils-D88A1f-Z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChqWdz1A.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-yBrxdh_6.js","snippetPresets-BgqDrFJC.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Duxc2rZw.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C7jidOil.js","shallow-xkjpHm-U.js","getApiPlaygroundDisplay-fE3rVpvL.js","CodeSnippet-LgxljKed.js","CodeSnippets-D-pXWDHq.js","Page-C2-BijcO.js","getPastedJson-CLRcu-uo.js","icon-Cxirpjgo.js","MethodPill-D49eqY5e.js","DuplicateIcon-CivCz5Rp.js","createIcon-D71qL3f5.js","DynamicMarkdown-BcGRTrw6.js","SectionHeading-DzaqmmSD.js","axios-vUo_bRtp.js","Markdown-CZqUYmMp.js","clsx-B6IZIRsp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B0ZV6X5T.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-MqLyPtsW.js"]}