Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key’s role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under x-plerion-actions and, where the permission applies to integrations, the integrations in scope under x-plerion-integration-scope. The document names the role under x-plerion-role.
Any tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly.
Send Accept: application/yaml to receive YAML instead of JSON.
Only the operations the key's role can call. Each operation may carry x-plerion-actions, the permissions any one of which authorizes the call, and x-plerion-integration-scope, either * for every integration in the tenant or an object naming the integrationIds and integrationGroupIds the role covers.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Plerion, Simplify Cloud Security - documentation","description":"Plerion, Simplify Cloud Security - documentation","colors":{"primary":"#FFA500","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/pleriondocs/GIwfwlVd5Zt2w0-r/logo/plerion.svg?fit=max\u0026auto=format\u0026n=GIwfwlVd5Zt2w0-r\u0026q=85\u0026s=86e89d26c3b52a61495baaf98faff52c","dark":"https://mintcdn.com/pleriondocs/GIwfwlVd5Zt2w0-r/logo/plerion.svg?fit=max\u0026auto=format\u0026n=GIwfwlVd5Zt2w0-r\u0026q=85\u0026s=86e89d26c3b52a61495baaf98faff52c"},"favicon":"https://mintcdn.com/pleriondocs/tawzAAKnRc9yNNhT/favicon.svg?fit=max\u0026auto=format\u0026n=tawzAAKnRc9yNNhT\u0026q=85\u0026s=43160b812d8a7d732e3a72cf166dbbec","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.plerion.com/sign-in"}},"footer":{"socials":{"x":"https://x.com/plerionhq","linkedin":"https://www.linkedin.com/company/plerion"},"links":[{"header":"Company","items":[{"label":"Plerion","href":"https://www.plerion.com"},{"label":"Contact","href":"https://www.plerion.com/company/contact-us"},{"label":"Partnerships","href":"https://www.plerion.com/company/partnerships"}]},{"header":"Resources","items":[{"label":"Blog","href":"https://www.plerion.com/blog"},{"label":"Trust center","href":"https://trust.plerion.com/"},{"label":"Privacy policy","href":"https://www.plerion.com/company/privacy-policy"}]}]},"search":{"prompt":"Search the docs"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pleriondocs","hasAudioNarration":false,"actualSubdomain":"pleriondocs","customDomains":["docs.plerion.com"],"gitSource":{"type":"github","owner":"plerionhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae40dfdc764d7391f5d8cf9","collectionId":"ab0f8aed-35d6-47c8-b3ee-a2986a5a26ec","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae40dfdc764d7391f5d8cf9"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae43b308aa3918b049c935b","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Guides","count":119},{"language":"default","tag":"API reference","count":102},{"language":"default","tag":"Integrations","count":71},{"language":"default","tag":"API documentation","count":60},{"language":"default","tag":"Cloud","count":47},{"language":"default","tag":"Platform","count":37},{"language":"default","tag":"CLI reference","count":24},{"language":"default","tag":"Organization API","count":21},{"language":"default","tag":"Commands","count":20},{"language":"default","tag":"AWS","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/tenant/discover","slug":"/api-reference/tenant/discover","pageMetadata":{"title":"Get what this key can call","description":"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key's role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under `x-plerion-actions` and, where the permission applies to integrations, the integrations in scope under `x-plerion-integration-scope`. The document names the role under `x-plerion-role`.\n\nAny tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly.\n\nSend `Accept: application/yaml` to receive YAML instead of JSON.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/openapi","href":"/api-reference/tenant/discover","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key’s role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under \", _jsx(_components.code, {\n children: \"x-plerion-actions\"\n }), \" and, where the permission applies to integrations, the integrations in scope under \", _jsx(_components.code, {\n children: \"x-plerion-integration-scope\"\n }), \". The document names the role under \", _jsx(_components.code, {\n children: \"x-plerion-role\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Any tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Send \", _jsx(_components.code, {\n children: \"Accept: application/yaml\"\n }), \" to receive YAML instead of JSON.\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Get what this key can call","description":"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key's role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under `x-plerion-actions` and, where the permission applies to integrations, the integrations in scope under `x-plerion-integration-scope`. The document names the role under `x-plerion-role`.\n\nAny tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly.\n\nSend `Accept: application/yaml` to receive YAML instead of JSON.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/openapi","href":"/api-reference/tenant/discover","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"discoverTenantApiAccess","tags":["Tenant"],"summary":"Discover","x-mint":{"metadata":{"title":"Get what this key can call"}},"description":"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key's role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under `x-plerion-actions` and, where the permission applies to integrations, the integrations in scope under `x-plerion-integration-scope`. The document names the role under `x-plerion-role`.\n\nAny tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly.\n\nSend `Accept: application/yaml` to receive YAML instead of JSON.","security":["68da58de-e490-4464-b910-8298f6c3bd40"],"parameters":["a0d69cea-faec-457c-a9ea-cfedbdf056e6","60e11050-b1d6-4339-8f3e-553bfef44bc7"],"responses":{"200":"95200093-b7c5-496e-adf3-323f1b6717c9","403":"5c407f09-7fc0-4559-a76b-063f9a029e3d","500":"06d94877-4f53-437f-91f2-433bb97c2b70"},"method":"get","type":"path","servers":["775cd936-5703-465a-b9f0-6d21440886d9"],"path":"/v1/tenant/openapi","baseUrlOptions":["https://{region}.api.plerion.com"],"title":"Discover","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a0d69cea-faec-457c-a9ea-cfedbdf056e6":{"name":"Authorization","in":"header","description":"Bearer API Key. For example, \"Bearer {Tenant API Key}\"","required":true,"schema":{"type":"string","isRequired":true,"description":"Bearer API Key. For example, \"Bearer {Tenant API Key}\"","uniqueKey":"","typeLabel":"string"}},"60e11050-b1d6-4339-8f3e-553bfef44bc7":{"in":"header","name":"Accept","description":"`application/json` (the default) or `application/yaml`","schema":{"type":"string","enum":["application/json","application/yaml"],"description":"`application/json` (the default) or `application/yaml`","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"95200093-b7c5-496e-adf3-323f1b6717c9":{"description":"The API reference limited to the calling key","content":{"application/json":{"schema":{"type":"object","description":"An OpenAPI 3.1 document. Only the fields Plerion adds are described here; the rest is standard OpenAPI.","properties":{"openapi":{"type":"string","example":"3.1.0","uniqueKey":"openapi","typeLabel":"string"},"info":{"type":"object","description":"The reference's metadata. Its `description` opens with the role the document was built for.","uniqueKey":"info","typeLabel":"object"},"paths":{"type":"object","description":"Only the operations the key's role can call. Each operation may carry `x-plerion-actions`, the permissions any one of which authorizes the call, and `x-plerion-integration-scope`, either `*` for every integration in the tenant or an object naming the `integrationIds` and `integrationGroupIds` the role covers.","additionalProperties":{"type":"object","uniqueKey":"paths.additionalProperties","typeLabel":"object"},"uniqueKey":"paths","typeLabel":"object"},"x-plerion-role":{"type":"object","description":"The role the document was built for.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"x-plerion-role.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","example":"Tenant read-only","uniqueKey":"x-plerion-role.name","typeLabel":"string"}},"uniqueKey":"x-plerion-role","typeLabel":"object"},"x-plerion-action-map":{"type":"string","description":"Hash of the action map the document was derived from, the same map the authorizer enforces.","uniqueKey":"x-plerion-action-map","typeLabel":"string"},"x-plerion-reference":{"type":"object","description":"Where the base reference came from.","properties":{"source":{"type":"string","example":"plerionhq/docs/api-reference/openapi.yaml@main","uniqueKey":"x-plerion-reference.source","typeLabel":"string"},"commit":{"type":"string","uniqueKey":"x-plerion-reference.commit","typeLabel":"string"},"fetchedAt":{"type":"string","format":"date-time","uniqueKey":"x-plerion-reference.fetchedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"x-plerion-reference","typeLabel":"object"},"x-plerion-generated-at":{"type":"string","format":"date-time","uniqueKey":"x-plerion-generated-at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"openapi":"3.1.0","info":{},"paths":{},"x-plerion-role":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"Tenant read-only"},"x-plerion-action-map":"\u003cstring>","x-plerion-reference":{"source":"plerionhq/docs/api-reference/openapi.yaml@main","commit":"\u003cstring>","fetchedAt":"2023-11-07T05:31:56Z"},"x-plerion-generated-at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"},"application/yaml":{"schema":{"type":"string","description":"The same document as YAML.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"},"5c407f09-7fc0-4559-a76b-063f9a029e3d":{"description":"Forbidden","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","example":"Forbidden","uniqueKey":"message","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Forbidden"}}},"exampleType":"generated"}},"exampleType":"generated"},"06d94877-4f53-437f-91f2-433bb97c2b70":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal server error","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"68da58de-e490-4464-b910-8298f6c3bd40":{"APIKey":{"type":"http","scheme":"bearer","bearerFormat":"apiKey","description":"Bearer API Key. For example, \"Bearer {Tenant API Key}\"","scopes":[]}}},"servers":{"775cd936-5703-465a-b9f0-6d21440886d9":{"url":"https://{region}.api.plerion.com","description":"Production API server - Select your preferred region","variables":{"region":{"default":"au","enum":["au","sg1","in1","us1"]}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"apiKey","description":"Bearer API Key. For example, \"Bearer {Tenant API Key}\"","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer API Key. For example, \"Bearer {Tenant API Key}\"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"APIKey","name":"Authorization"}],"title":"APIKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"pleriondocs","siteName":"Plerion, Simplify Cloud Security - documentation","title":"Get what this key can call - Plerion, Simplify Cloud Security - documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T04:43:06.234Z","originalFileLocation":"api-reference/tenant/discover.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=\"system\"}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=\"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key\u0026#x27;s role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under x-plerion-actions and, where the permission applies to integrations, the integrations in scope under x-plerion-integration-scope. The document names the role under x-plerion-role. Any tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly. Send Accept: application/yaml to receive YAML instead of JSON.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Plerion, Simplify Cloud Security - documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_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=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get what this key can call - Plerion, Simplify Cloud Security - documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key\u0026#x27;s role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under x-plerion-actions and, where the permission applies to integrations, the integrations in scope under x-plerion-integration-scope. The document names the role under x-plerion-role. Any tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly. Send Accept: application/yaml to receive YAML instead of JSON.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Plerion, Simplify Cloud Security - documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.plerion.com/api-reference/tenant/discover\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pleriondocs.mintlify.app/_mintlify/api/og/v2?division=Tenant\u0026amp;title=Get+what+this+key+can+call\u0026amp;description=Use+the+discover+API+to+learn+which+operations+the+calling+key+can+call.+The+response+is+this+API+reference+as+an+OpenAPI+3.1+document+limited+to+the+key%27s+role\u0026amp;theme=20f0c40f02b58da5abe20cea\u0026amp;signature=6ce31cdc04d0bdd199a771e6844cdcfe6f6c0255fc1d65cd95fa6a1ba56b6729\">\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=\"Get what this key can call - Plerion, Simplify Cloud Security - documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key\u0026#x27;s role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under x-plerion-actions and, where the permission applies to integrations, the integrations in scope under x-plerion-integration-scope. The document names the role under x-plerion-role. Any tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly. Send Accept: application/yaml to receive YAML instead of JSON.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pleriondocs.mintlify.app/_mintlify/api/og/v2?division=Tenant\u0026amp;title=Get+what+this+key+can+call\u0026amp;description=Use+the+discover+API+to+learn+which+operations+the+calling+key+can+call.+The+response+is+this+API+reference+as+an+OpenAPI+3.1+document+limited+to+the+key%27s+role\u0026amp;theme=20f0c40f02b58da5abe20cea\u0026amp;signature=6ce31cdc04d0bdd199a771e6844cdcfe6f6c0255fc1d65cd95fa6a1ba56b6729\">\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=\"/mintlify-assets/_mintlify/favicons/pleriondocs/xDuw_jwQ1ux0MEWx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Plerion, Simplify Cloud Security - documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FFA500\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.plerion.com/api-reference/tenant/discover\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tenant/discover.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.plerion.com/#organization\",\"name\":\"Plerion, Simplify Cloud Security - documentation\",\"url\":\"https://docs.plerion.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pleriondocs/GIwfwlVd5Zt2w0-r/logo/plerion.svg?fit=max\u0026auto=format\u0026n=GIwfwlVd5Zt2w0-r\u0026q=85\u0026s=86e89d26c3b52a61495baaf98faff52c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.plerion.com#website\",\"name\":\"Plerion, Simplify Cloud Security - documentation\",\"url\":\"https://docs.plerion.com\",\"publisher\":{\"@id\":\"https://docs.plerion.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.plerion.com/api-reference/tenant/discover#webpage\",\"url\":\"https://docs.plerion.com/api-reference/tenant/discover\",\"name\":\"Get what this key can call\",\"description\":\"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key's role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under x-plerion-actions and, where the permission applies to integrations, the integrations in scope under x-plerion-integration-scope. The document names the role under x-plerion-role. Any tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly. Send Accept: application/yaml to receive YAML instead of JSON.\",\"dateModified\":\"2026-10-05T04:43:06.234Z\",\"isPartOf\":{\"@id\":\"https://docs.plerion.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.plerion.com/api-reference/tenant/discover#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.plerion.com/api-reference/tenant/discover#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API documentation\",\"item\":\"https://docs.plerion.com/api-reference/findings/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tenant\",\"item\":\"https://docs.plerion.com/api-reference/tenant/get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get what this key can call\",\"item\":\"https://docs.plerion.com/api-reference/tenant/discover\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.plerion.com/api-reference/tenant/discover#apireference\",\"headline\":\"Get what this key can call\",\"name\":\"Get what this key can call\",\"description\":\"Use the discover API to learn which operations the calling key can call. The response is this API reference as an OpenAPI 3.1 document limited to the key's role: operations the role cannot call are left out, and each remaining operation carries the permission that authorizes it under x-plerion-actions and, where the permission applies to integrations, the integrations in scope under x-plerion-integration-scope. The document names the role under x-plerion-role. Any tenant API key can call this operation. A key with the Tenant admin role receives the whole reference. The answer is specific to the calling key, so cache it only for that key and only briefly. Send Accept: application/yaml to receive YAML instead of JSON.\",\"url\":\"https://docs.plerion.com/api-reference/tenant/discover\",\"mainEntityOfPage\":{\"@id\":\"https://docs.plerion.com/api-reference/tenant/discover#webpage\"},\"dateModified\":\"2026-10-05T04:43:06.234Z\",\"publisher\":{\"@id\":\"https://docs.plerion.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.plerion.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Plerion, Simplify Cloud Security - documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Plerion, Simplify Cloud Security - documentation","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/getting-started"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Quick start with Plerion API","href":"/api-reference"},{"title":"API categories","href":"/api-reference/api-categories"}]},{"group":"API documentation","pages":[{"group":"Findings","pages":[{"title":"List findings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/findings","href":"/api-reference/findings/list"}]},{"group":"Alerts","pages":[{"title":"List alerts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/alerts","href":"/api-reference/alerts/list"}]},{"group":"AWS integration","pages":[{"title":"Get the tenant's external ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/external-id","href":"/api-reference/aws-integration/get-external-id"},{"title":"Create an onboarding token for a new integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/integrations/token","href":"/api-reference/aws-integration/generate-temporary-token"},{"title":"Get the onboarding CloudFormation template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/cloudformation-templates","href":"/api-reference/aws-integration/get-cloudformation-template"}]},{"group":"Tenant","pages":[{"title":"Get this tenant","description":"Use the get tenant details API to retrieve information about the tenant including tenant ID, organization ID, name, creation date, last updated date, and current risk score.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant","href":"/api-reference/tenant/get"},{"title":"Get what this key can call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/openapi","href":"/api-reference/tenant/discover"},{"title":"Get this tenant's usage","description":"Use the get tenant usage API to get the usage details of the tenant. The API retrieves the total consumed Plerion units for the tenant for the specified period and additional information regarding whether the limit has been exceeded.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/usage","href":"/api-reference/tenant/usage"}]},{"group":"Integrations","pages":[{"title":"List inbound integrations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/integrations","href":"/api-reference/integrations/list-inbound-integrations"},{"title":"Replace an integration's user-defined tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/tenant/integrations/{integrationId}/user-defined-tags","href":"/api-reference/integrations/replace-user-defined-tags"}]},{"group":"Code security","pages":[{"title":"Upload infrastructure code for scanning","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/shiftleft/iac/scan","href":"/api-reference/code-security/upload-iac"},{"title":"List code scans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/shiftleft/iac/scans","href":"/api-reference/code-security/list-scans"},{"title":"List a code scan's findings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/shiftleft/iac/scans/{scanId}/findings","href":"/api-reference/code-security/list-findings"},{"title":"List a code scan's vulnerabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/shiftleft/iac/scans/{scanId}/vulnerabilities","href":"/api-reference/code-security/list-vulnerabilities"}]},{"group":"Compliance frameworks","pages":[{"title":"List compliance frameworks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/compliance-frameworks","href":"/api-reference/compliance-frameworks/list"},{"title":"Download a compliance report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/integrations/{integrationId}/compliance-frameworks/{complianceId}/download","href":"/api-reference/compliance-frameworks/download-report"},{"title":"Request a compliance report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/integrations/{integrationId}/frameworks/{complianceFrameworkId}/reports","href":"/api-reference/compliance-frameworks/request-a-framework-report"}]},{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/assets","href":"/api-reference/assets/list"},{"title":"Get an asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/assets/{assetId}","href":"/api-reference/assets/get"},{"title":"Get an asset's SBOM","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/assets/{assetId}/sbom","href":"/api-reference/assets/get-sbom"},{"title":"Get an SBOM by asset ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/assets/sbom","href":"/api-reference/assets/get-sbom-by-asset-id"}]},{"group":"Asset groups","pages":[{"title":"List asset groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/asset-groups","href":"/api-reference/asset-groups/list"},{"title":"Create an asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/asset-groups","href":"/api-reference/asset-groups/create"},{"title":"Get an asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/asset-groups/{assetGroupId}","href":"/api-reference/asset-groups/get"},{"title":"Delete an asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tenant/asset-groups/{assetGroupId}","href":"/api-reference/asset-groups/delete"},{"title":"Update an asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/tenant/asset-groups/{assetGroupId}","href":"/api-reference/asset-groups/update"}]},{"group":"Well-Architected frameworks","pages":[{"title":"List Well-Architected frameworks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/well-architected-frameworks","href":"/api-reference/well-architected-frameworks/list"},{"title":"Download a Well-Architected report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/integrations/{integrationId}/well-architected-frameworks/{wellArchitectedFrameworkId}/download","href":"/api-reference/well-architected-frameworks/download-report"},{"title":"Request a Well-Architected report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/integrations/{integrationId}/frameworks/{wellArchitectedFrameworkId}/reports","href":"/api-reference/well-architected-frameworks/request-framework-report"}]},{"group":"Vulnerabilities","pages":[{"title":"List vulnerabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/vulnerabilities","href":"/api-reference/vulnerabilities/list"},{"title":"List vulnerability exemptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/profiles/{profileId}/vulnerability/exemptions","href":"/api-reference/vulnerabilities/list-vulnerability-exemptions-in-a-profile"},{"title":"Create a vulnerability exemption","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/profiles/{profileId}/vulnerability/exemptions","href":"/api-reference/vulnerabilities/create-a-vulnerability-exemption-in-a-profile"},{"title":"Get a vulnerability exemption","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/profiles/{profileId}/vulnerability/exemptions/{id}","href":"/api-reference/vulnerabilities/get-a-vulnerability-exemption-by-id"},{"title":"Delete a vulnerability exemption","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tenant/profiles/{profileId}/vulnerability/exemptions/{id}","href":"/api-reference/vulnerabilities/delete-a-vulnerability-exemption-by-id"},{"title":"Update a vulnerability exemption","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/tenant/profiles/{profileId}/vulnerability/exemptions/{id}","href":"/api-reference/vulnerabilities/update-a-vulnerability-exemption-by-id"}]},{"group":"Profiles","pages":[{"title":"List profiles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/profiles","href":"/api-reference/profiles/list"}]},{"group":"Detection exemptions","pages":[{"title":"Get a detection's exemptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/profiles/{profileId}/detection-settings/{detectionId}/exemptions","href":"/api-reference/detection-exemptions/get"},{"title":"Replace a detection's exemptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/tenant/profiles/{profileId}/detection-settings/{detectionId}/exemptions","href":"/api-reference/detection-exemptions/replace"}]},{"group":"Risks","pages":[{"title":"List risks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/risks","href":"/api-reference/risks/list"},{"title":"Get a risk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/risks/{riskId}","href":"/api-reference/risks/get"}]},{"group":"Audit logs","pages":[{"title":"List audit logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/audit-logs","href":"/api-reference/audit-logs/list"}]},{"group":"Custom checks","pages":[{"title":"List custom checks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/custom-checks","href":"/api-reference/custom-checks/list"},{"title":"Create a custom check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/custom-checks","href":"/api-reference/custom-checks/create"},{"title":"Get a custom check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/custom-checks/{customCheckId}","href":"/api-reference/custom-checks/get"},{"title":"Replace a custom check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/tenant/custom-checks/{customCheckId}","href":"/api-reference/custom-checks/update"},{"title":"Delete a custom check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tenant/custom-checks/{customCheckId}","href":"/api-reference/custom-checks/delete"},{"title":"Start a custom check dry run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/custom-check-dry-runs","href":"/api-reference/custom-checks/start-dry-run"},{"title":"Get a dry run's status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/custom-check-dry-runs/{dryRunId}","href":"/api-reference/custom-checks/get-dry-run-status"}]},{"group":"Metrics","pages":[{"title":"Query metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/metrics","href":"/api-reference/metrics/query"}]},{"group":"Workload scans","pages":[{"title":"Request a workload scan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/workload/scans","href":"/api-reference/workload-scans/request"},{"title":"Get a workload scan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/workload/scans/{scanId}","href":"/api-reference/workload-scans/get"}]},{"group":"AWS access grants","pages":[{"title":"List AWS access grants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/aws/access-grants","href":"/api-reference/aws-access-grants/list"},{"title":"Get access grant counts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/aws/access-grants/stats","href":"/api-reference/aws-access-grants/stats"},{"title":"List external principals with access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/aws/access-grants/external-principals","href":"/api-reference/aws-access-grants/external-principals"},{"title":"Get an AWS access grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/aws/access-grants/{id}","href":"/api-reference/aws-access-grants/get"},{"title":"Review an AWS access grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/tenant/aws/access-grants/{id}","href":"/api-reference/aws-access-grants/update"}]},{"group":"Custom dashboards","pages":[{"title":"List the tenant's custom dashboards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/custom-reports","href":"/api-reference/custom-dashboards/list"}]},{"group":"Preferences","pages":[{"title":"Get the tenant default home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tenant/preferences/home-dashboard","href":"/api-reference/preferences/get-tenant-default"},{"title":"Set the tenant default home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/tenant/preferences/home-dashboard","href":"/api-reference/preferences/set-tenant-default"},{"title":"Clear the tenant default home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tenant/preferences/home-dashboard","href":"/api-reference/preferences/clear-tenant-default"}]}]},{"group":"Organization API","pages":[{"group":"Roles","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/roles","href":"/api-reference/roles/list-roles"},{"title":"Create a custom role","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml post /v1/organization/roles","href":"/api-reference/roles/create-a-custom-role"},{"title":"Get a role","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/roles/{roleId}","href":"/api-reference/roles/get-a-role"},{"title":"Update a custom role","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml put /v1/organization/roles/{roleId}","href":"/api-reference/roles/update-a-custom-role"},{"title":"Delete a custom role","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml delete /v1/organization/roles/{roleId}","href":"/api-reference/roles/delete-a-custom-role"}]},{"group":"Role assignments","pages":[{"title":"List role assignments","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/role-assignments","href":"/api-reference/role-assignments/list-role-assignments"},{"title":"Assign a role","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml post /v1/organization/role-assignments","href":"/api-reference/role-assignments/assign-a-role"},{"title":"Revoke a role","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml delete /v1/organization/role-assignments/{roleId}/{principalType}/{principalId}","href":"/api-reference/role-assignments/revoke-a-role"}]},{"group":"Permission catalog","pages":[{"title":"Get the permission catalog","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/permission-catalog","href":"/api-reference/permission-catalog/get-the-permission-catalog"}]},{"group":"Preferences","pages":[{"title":"Get a user's home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/users/{userId}/preferences/home-dashboard","href":"/api-reference/preferences/get-a-users-home-dashboard"},{"title":"Set a user's home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml put /v1/organization/users/{userId}/preferences/home-dashboard","href":"/api-reference/preferences/set-a-users-home-dashboard"},{"title":"Clear a user's home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml delete /v1/organization/users/{userId}/preferences/home-dashboard","href":"/api-reference/preferences/clear-a-users-home-dashboard"},{"title":"Get a user's navigation","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/users/{userId}/preferences/navigation","href":"/api-reference/preferences/get-a-users-navigation"},{"title":"Set a user's navigation","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml put /v1/organization/users/{userId}/preferences/navigation","href":"/api-reference/preferences/set-a-users-navigation"},{"title":"Clear a user's navigation","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml delete /v1/organization/users/{userId}/preferences/navigation","href":"/api-reference/preferences/clear-a-users-navigation"},{"title":"Get a user group's home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/user-groups/{groupId}/preferences/home-dashboard","href":"/api-reference/preferences/get-a-user-groups-home-dashboard"},{"title":"Set a user group's home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml put /v1/organization/user-groups/{groupId}/preferences/home-dashboard","href":"/api-reference/preferences/set-a-user-groups-home-dashboard"},{"title":"Clear a user group's home dashboard","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml delete /v1/organization/user-groups/{groupId}/preferences/home-dashboard","href":"/api-reference/preferences/clear-a-user-groups-home-dashboard"},{"title":"Get a user group's navigation","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml get /v1/organization/user-groups/{groupId}/preferences/navigation","href":"/api-reference/preferences/get-a-user-groups-navigation"},{"title":"Set a user group's navigation","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml put /v1/organization/user-groups/{groupId}/preferences/navigation","href":"/api-reference/preferences/set-a-user-groups-navigation"},{"title":"Clear a user group's navigation","deprecated":null,"version":null,"openapi":"/api-reference/organization-openapi.yaml delete /v1/organization/user-groups/{groupId}/preferences/navigation","href":"/api-reference/preferences/clear-a-user-groups-navigation"}]}]},{"group":"SCIM API","pages":[{"group":"Discovery","pages":[{"title":"Supported SCIM protocol features","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/ServiceProviderConfig","href":"/api-reference/discovery/supported-scim-protocol-features"},{"title":"List supported resource types","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/ResourceTypes","href":"/api-reference/discovery/list-supported-resource-types"},{"title":"Get one resource type","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/ResourceTypes/{resourceTypeId}","href":"/api-reference/discovery/get-one-resource-type"},{"title":"List attribute schemas","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/Schemas","href":"/api-reference/discovery/list-attribute-schemas"},{"title":"Get one attribute schema","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/Schemas/{schemaUri}","href":"/api-reference/discovery/get-one-attribute-schema"}]},{"group":"Users","pages":[{"title":"List or filter users","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/Users","href":"/api-reference/users/list-or-filter-users"},{"title":"Create or adopt a user","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml post /v1/organization/scim/v2/Users","href":"/api-reference/users/create-or-adopt-a-user"},{"title":"Get one user","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/Users/{userId}","href":"/api-reference/users/get-one-user"},{"title":"Replace a user","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml put /v1/organization/scim/v2/Users/{userId}","href":"/api-reference/users/replace-a-user"},{"title":"Deprovision a user","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml delete /v1/organization/scim/v2/Users/{userId}","href":"/api-reference/users/deprovision-a-user"},{"title":"Partially update a user","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml patch /v1/organization/scim/v2/Users/{userId}","href":"/api-reference/users/partially-update-a-user"},{"title":"Search users with a request body","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml post /v1/organization/scim/v2/Users/.search","href":"/api-reference/users/search-users-with-a-request-body"}]},{"group":"Groups","pages":[{"title":"List or filter groups","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/Groups","href":"/api-reference/groups/list-or-filter-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml post /v1/organization/scim/v2/Groups","href":"/api-reference/groups/create-a-group"},{"title":"Get one group","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml get /v1/organization/scim/v2/Groups/{groupId}","href":"/api-reference/groups/get-one-group"},{"title":"Replace a group","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml put /v1/organization/scim/v2/Groups/{groupId}","href":"/api-reference/groups/replace-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml delete /v1/organization/scim/v2/Groups/{groupId}","href":"/api-reference/groups/delete-a-group"},{"title":"Partially update a group","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml patch /v1/organization/scim/v2/Groups/{groupId}","href":"/api-reference/groups/partially-update-a-group"},{"title":"Search groups with a request body","deprecated":null,"version":null,"openapi":"/api-reference/scim-openapi.yaml post /v1/organization/scim/v2/Groups/.search","href":"/api-reference/groups/search-groups-with-a-request-body"}]}]}]},{"tab":"CLI reference","pages":[{"title":"CLI reference","href":"/cli-reference/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"FAQs","hidden":true,"pages":[{"title":"FAQs","href":"/faqs"}]}]},"title":"Get what this key can call - Plerion, Simplify Cloud Security - documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}