Additional asset types loaded in full and made available to the policy.
Show child attributes
Was this page helpful?
{"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":"6adf0ddefb05475c270a945d","collectionId":"37bd62b1-7000-4b89-91fa-d26c8855b23d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf0ddefb05475c270a945d"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adf0ddefb05475c270a945d","clientVersion":"0.0.3969","searchFilterCounts":[{"language":"default","tag":"Guides","count":118},{"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":36},{"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/custom-checks/create","slug":"/api-reference/custom-checks/create","pageMetadata":{"title":"Create a custom check","description":"Create a new custom (rego) check. The created check is returned, including its generated `customCheckId` and initial `version`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/custom-checks","href":"/api-reference/custom-checks/create","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Create a new custom (rego) check. The created check is returned, including its generated \", _jsx(_components.code, {\n children: \"customCheckId\"\n }), \" and initial \", _jsx(_components.code, {\n children: \"version\"\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":"Create a custom check","description":"Create a new custom (rego) check. The created check is returned, including its generated `customCheckId` and initial `version`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tenant/custom-checks","href":"/api-reference/custom-checks/create","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createCustomCheck","tags":["Custom checks"],"summary":"Create","x-mint":{"metadata":{"title":"Create a custom check"}},"description":"Create a new custom (rego) check. The created check is returned, including its generated `customCheckId` and initial `version`.","security":["c3bdd908-f8dc-47b9-81d4-ffc65e6c6072"],"parameters":["6d5afc8c-6e48-4bca-ac9f-fb6c3f6acc23","356d9c11-5791-4905-b4a8-118ee0221d15"],"requestBody":"0da0b373-10f1-45f4-938f-79479683ec0d","responses":{"200":"f4b80140-eeb5-4e2d-b83f-fc1198cfc0b3","400":"54fe00d3-5bb6-4b4a-ad83-76a0e0ec1c46","500":"eaeb299f-4605-4dc1-9dfa-25356293b50f"},"method":"post","type":"path","servers":["775cd936-5703-465a-b9f0-6d21440886d9"],"path":"/v1/tenant/custom-checks","baseUrlOptions":["https://{region}.api.plerion.com"],"title":"Create","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6d5afc8c-6e48-4bca-ac9f-fb6c3f6acc23":{"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"}},"356d9c11-5791-4905-b4a8-118ee0221d15":{"in":"header","name":"Content-Type","description":"application/json","schema":{"type":"string","description":"application/json","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Fields for creating or replacing a custom check.","required":["slug","title","target","defaults","type","body"],"additionalProperties":false,"properties":{"slug":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z0-9-]+$","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"title":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"target":{"type":"object","description":"The primary asset type a check evaluates and how it is batched.","required":["assetType","scope"],"additionalProperties":false,"properties":{"assetType":{"type":"string","minLength":1,"example":"AWS::S3::Bucket","isRequired":true,"uniqueKey":"target.assetType","typeLabel":"string"},"scope":{"type":"string","description":"`all` evaluates the whole population at once; `batch` chunks it.","enum":["batch","all"],"isRequired":true,"uniqueKey":"target.scope","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"target","typeLabel":"object"},"defaults":{"type":"object","description":"Default verdict values applied to findings the check produces.","required":["severityLevel","message","informational"],"additionalProperties":false,"properties":{"severityLevel":{"type":"string","enum":["INFORMATIONAL","LOW","MEDIUM","HIGH","CRITICAL"],"isRequired":true,"uniqueKey":"defaults.severityLevel","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"defaults.message","typeLabel":"string"},"informational":{"type":"boolean","isRequired":true,"uniqueKey":"defaults.informational","typeLabel":"boolean"},"remediation":{"type":"string","maxLength":4096,"uniqueKey":"defaults.remediation","typeLabel":"string"},"meta":{"type":"object","uniqueKey":"defaults.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"defaults","typeLabel":"object"},"type":{"type":"string","enum":["rego"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"body":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"body","typeLabel":"string"},"description":{"type":"string","maxLength":4096,"uniqueKey":"description","typeLabel":"string"},"additionalAssets":{"type":"array","items":{"type":"object","required":["assetType"],"additionalProperties":false,"properties":{"assetType":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].assetType","typeLabel":"string"}},"uniqueKey":"additionalAssets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"additionalAssets","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"slug":"\u003cstring>","title":"\u003cstring>","target":{"assetType":"AWS::S3::Bucket"},"defaults":{"message":"\u003cstring>","informational":true,"remediation":"\u003cstring>","meta":{}},"type":"rego","body":"\u003cstring>","description":"\u003cstring>","additionalAssets":[{"assetType":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f4b80140-eeb5-4e2d-b83f-fc1198cfc0b3":{"description":"The created custom check","content":{"application/json":{"schema":{"type":"object","description":"A stored custom check.","required":["customCheckId","slug","organizationId","tenantId","title","target","defaults","type","body","version","createdBy","createdAt","updatedBy","updatedAt"],"properties":{"customCheckId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"customCheckId","typeLabel":"string\u003cuuid>"},"slug":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z0-9-]+$","description":"URL-safe identifier, unique within the tenant.","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"organizationId":{"type":"string","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string"},"tenantId":{"type":"string","isRequired":true,"uniqueKey":"tenantId","typeLabel":"string"},"title":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"target":{"type":"object","description":"The primary asset type a check evaluates and how it is batched.","required":["assetType","scope"],"additionalProperties":false,"properties":{"assetType":{"type":"string","minLength":1,"example":"AWS::S3::Bucket","isRequired":true,"uniqueKey":"target.assetType","typeLabel":"string"},"scope":{"type":"string","description":"`all` evaluates the whole population at once; `batch` chunks it.","enum":["batch","all"],"isRequired":true,"uniqueKey":"target.scope","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"target","typeLabel":"object"},"defaults":{"type":"object","description":"Default verdict values applied to findings the check produces.","required":["severityLevel","message","informational"],"additionalProperties":false,"properties":{"severityLevel":{"type":"string","enum":["INFORMATIONAL","LOW","MEDIUM","HIGH","CRITICAL"],"isRequired":true,"uniqueKey":"defaults.severityLevel","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"defaults.message","typeLabel":"string"},"informational":{"type":"boolean","isRequired":true,"uniqueKey":"defaults.informational","typeLabel":"boolean"},"remediation":{"type":"string","maxLength":4096,"uniqueKey":"defaults.remediation","typeLabel":"string"},"meta":{"type":"object","uniqueKey":"defaults.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"defaults","typeLabel":"object"},"type":{"type":"string","enum":["rego"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"body":{"type":"string","minLength":1,"description":"The rego policy source.","isRequired":true,"uniqueKey":"body","typeLabel":"string"},"version":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"version","typeLabel":"integer"},"createdBy":{"type":"string","isRequired":true,"uniqueKey":"createdBy","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedBy":{"type":"string","isRequired":true,"uniqueKey":"updatedBy","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","maxLength":4096,"uniqueKey":"description","typeLabel":"string"},"additionalAssets":{"type":"array","description":"Additional asset types loaded in full and made available to the policy.","items":{"type":"object","required":["assetType"],"additionalProperties":false,"properties":{"assetType":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].assetType","typeLabel":"string"}},"uniqueKey":"additionalAssets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"additionalAssets","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customCheckId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","slug":"\u003cstring>","organizationId":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","target":{"assetType":"AWS::S3::Bucket","scope":"batch"},"defaults":{"severityLevel":"INFORMATIONAL","message":"\u003cstring>","informational":true,"remediation":"\u003cstring>","meta":{}},"type":"rego","body":"\u003cstring>","version":2,"createdBy":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedBy":"\u003cstring>","updatedAt":"2023-11-07T05:31:56Z","description":"\u003cstring>","additionalAssets":[{"assetType":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"54fe00d3-5bb6-4b4a-ad83-76a0e0ec1c46":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"field":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"eaeb299f-4605-4dc1-9dfa-25356293b50f":{"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":{"c3bdd908-f8dc-47b9-81d4-ffc65e6c6072":{"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":"Create a custom check - Plerion, Simplify Cloud Security - documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T04:43:06.673Z","originalFileLocation":"api-reference/custom-checks/create.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=\"Create a new custom (rego) check. The created check is returned, including its generated customCheckId and initial version.\">\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=\"Create a custom check - Plerion, Simplify Cloud Security - documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new custom (rego) check. The created check is returned, including its generated customCheckId and initial version.\">\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/custom-checks/create\">\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=Custom+checks\u0026amp;title=Create+a+custom+check\u0026amp;description=Create+a+new+custom+%28rego%29+check.+The+created+check+is+returned%2C+including+its+generated+%60customCheckId%60+and+initial+%60version%60.\u0026amp;theme=20f0c40f02b58da5abe20cea\u0026amp;signature=5e29a7fba29a438434ef4ef6f6b0db9d857847738b54ef45ad484917436a6f6e\">\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 a custom check - Plerion, Simplify Cloud Security - documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new custom (rego) check. The created check is returned, including its generated customCheckId and initial version.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pleriondocs.mintlify.app/_mintlify/api/og/v2?division=Custom+checks\u0026amp;title=Create+a+custom+check\u0026amp;description=Create+a+new+custom+%28rego%29+check.+The+created+check+is+returned%2C+including+its+generated+%60customCheckId%60+and+initial+%60version%60.\u0026amp;theme=20f0c40f02b58da5abe20cea\u0026amp;signature=5e29a7fba29a438434ef4ef6f6b0db9d857847738b54ef45ad484917436a6f6e\">\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/custom-checks/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custom-checks/create.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/custom-checks/create#webpage\",\"url\":\"https://docs.plerion.com/api-reference/custom-checks/create\",\"name\":\"Create a custom check\",\"description\":\"Create a new custom (rego) check. The created check is returned, including its generated customCheckId and initial version.\",\"dateModified\":\"2026-10-05T04:43:06.673Z\",\"isPartOf\":{\"@id\":\"https://docs.plerion.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.plerion.com/api-reference/custom-checks/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.plerion.com/api-reference/custom-checks/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API documentation\",\"item\":\"https://docs.plerion.com/api-reference/findings/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Custom checks\",\"item\":\"https://docs.plerion.com/api-reference/custom-checks/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a custom check\",\"item\":\"https://docs.plerion.com/api-reference/custom-checks/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.plerion.com/api-reference/custom-checks/create#apireference\",\"headline\":\"Create a custom check\",\"name\":\"Create a custom check\",\"description\":\"Create a new custom (rego) check. The created check is returned, including its generated customCheckId and initial version.\",\"url\":\"https://docs.plerion.com/api-reference/custom-checks/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.plerion.com/api-reference/custom-checks/create#webpage\"},\"dateModified\":\"2026-10-05T04:43:06.673Z\",\"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","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","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","description":"Retrieve the custom checks defined in the tenant. Supports filtering by asset type and target scope, with cursor-based pagination.","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","description":"Fetch a single custom check by its ID.","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":"Create a custom check - Plerion, Simplify Cloud Security - documentation","buildId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","deploymentId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-S3ptrr-V.js","utils-CUxEJy9u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DavhVrxy.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1sOUY6E.js","snippetPresets-C-RLYOrF.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Duz18EdI.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DPsbCc6D.js","shallow-B1dlhlOw.js","getApiPlaygroundDisplay-DvOu-BhE.js","CodeSnippet-By8wd64X.js","CodeSnippets-BxVv6TjI.js","Page-BGh0lBck.js","getPastedJson-DOAt9xJn.js","icon-BYg-qtQ2.js","MethodPill-Dtah8ZSz.js","DuplicateIcon-guWfDmh1.js","createIcon-pTGhj_hk.js","DynamicMarkdown-DpsHMHVL.js","SectionHeading-BbutQCjq.js","axios-vUo_bRtp.js","Markdown-DZ-stgDu.js","clsx-Dfme4k4V.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CPNs0ebX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-3JVAA-i3.js"]}