LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/create-sod-policy.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

120 lines
57 KiB
Plaintext
Raw Blame History

---
id: create-sod-policy
sidebar_label: Create SOD policy
hide_title: true
hide_table_of_contents: true
api: eJztHWtTG0fyr0ztVZ2NixV6IRBf7mSBHVIYHCGfLwEqGe3OSuOsdpR9gBWK/37dPbMvSSBhbMfObWIbaXemp7un372z3FpqJkIeSxUcu9aB5YSCx+JcuW+VL525tW3FfBxZBxfW+dkhMxevti1XzELhwFCYFIeJ2LYi4SShjOcw9tZ6F4mwr4JYfIx7STzB+dINDiLl2jOCcXADY4V1dUewIieUM8QBMBhOZMQ0GhEbqXjCXosAUPQZD1wGQD2YH8tgzHqOI6KIveSRcJkGu81uJMzgzJdTGTPlsd06E0EsY19M4WfEPBUywZ0Je+4LL2b/ZKEcT+ItWBHwCSWnAfeugkzQK9Uug4H4I5EhYBkqX+BaZ4PXv/YO3xyf1oBvIdwVUfxSucCSW/oKgzN2OcidIMZbfDYDiLQHOx8iZMKtFTkTMeX4KZ7PBLBFjT4IJwa4sxB3LJYiwrvSLYyJ4hAwthY5qneNHR8iWuIjn858HF33Gg2vydv2ntNt2+2R17J5c+Tae+3m7n7dE62RK4gO7p4F/lwjfrdtBXwqNl50lEQyQP7hrPL6mo/2x/mfFkDVO76SGtiRKQdOWS6MsGM5FUurDSeC4Q12MxEBi1GE8q1imUC5ZQya9Wbdrjfgz7BeP6A/tTr998sqwqfKlZ78cjim8J+EZGnNdZt0Rh9AtQqXUZBjQLUg6iV8SD8N0iKIElQAR8FNyQOH1AB3FMQk8X0+wikGM3UDajwQ3iqhXkALRz6LmHRJdQmBstjr+WvJM3AOh2cMRxIhQTJFc3R8eHQ6PB7+jMYsJy67CvhuolqLmC4pWdPpNvbrvN3xOHeFaNcbHW/UFvXGvtOsd1pda2OFSpdyZTTz+XyFQp0ns5kKY+sOYJLFS2cdxgrXAWMsQthtrZqwEyIUsGWPEJMUQrr/YQqjjMh/f/7FjFglB/rOT4kI5+uXPhc8BGP9B45eJ5n/5mSqn0v3YAPbNt5ivdND9rhJ3hbZKhB3EH2O/gG9HNj/6BFcLE5njpnPnr+RsRzriynQrTKBP/BrAb5tygM+FiFw/1qKG2JJHHIA6JD+usKREXzQvg7uypBdWiohd5hr6qXFBHxWcyFW7ZKjQnDwCLDnXstHSUk+lXGaW6ZCe1IVEOKp68TPKTrbKYURiyYq8V2gdKqQdO2K4wmP0V4GKmapWy3Q+kGNmJcEhEBtFWlRDDZ6PT3vJwIAEtSCkRYBrOQgASEiUDQpR6evzgb9o0O4dHo2/DX7WrIw2dW7NLTK8OBhyOfLbgMGpdSleGi7WWLrhTXsvW7AFfjRxCUhnJmukMq71Neq8Hjj2OGZcaCAxeeKIoyzexwS6aRPxaIsCiuwupbKp0CM7GYviuQ4wLgRA0I5RkwXQTwcnvEMwiDxV8pcKjxveqe910cDuHI+7A2P+9Y2rrQUHR+KmEuwFnyECo0ikaEcMfKwEJgaWMzO/BLyTuvUZaDhw83XoFNgzdFrvw5VMkORPjYTStzNcXvQqXPfP/Mo/K/c+9d374uieXdVHPifhwUbrSJkHC4IaZEtIwXmmQdLyB4KD6N6jGTJRPLUME045GwCwtsMWtFOpqRozXGFxxMfYmaP+xHK0ma7/n5xTTDKOjwYaccSok/N0jfjM+hezSqsar0+Oj0a9E4KQpNf6Z+dvjo57g+PTyGj6/ePzs9/fdk7X7Tl6Xhyl9mSOmHsm3zyYcUoiz1mpMV5D4/eTK5eFhOwzI8YrgDWMC1xYsiXo7gkbVMViLktA52baZxOcNA6f4WDKNIwk2qMQeYTCtwniF0kJRgNSuan/KNJ0clZMaljAsQFt2rRg93Dh/vEJnfLoPInR2/gp7VsT43tsMo+Op+xoaU4PkyjGI0lixVoh4TQlRK9LFBmlOyD6oDOLhuS/d3OvrPb7DodMCT7jsM7XrfuNFqN1uaG5IcELL2Nng1tQcmePA3FngubB1sTYhwAVuiuGH1kWBV5p1mX0tbpNDqd0e6oDrQ1OntOqym8VoN3OlZK2uIS20+Auncv1JJdXFBWuEP1oEoLKy2stPAv08LCrf69jnVdyJMXsXMekajeW901w2HINfcTkat3cYqtR9mnfGWNb7Pi2IpaWBabljl7vyxmnKWQjhE+D1V5ymWZ1TWML1liWK4ofPVSgMn8i5l62t4wenxVyo43zSuLyeymc9anmovJYyEP+6zyk+UGrChJ5ZSglOzeGx2viYMX41uzfubkFn3c0+zZEw0XGJMVwUAJZRD4z4rz/tNw7pJVxY1LO2YrDNpiIpd/e4xU7XX2m16X75NUtbpOfVfsew3ueY+3SqdgXzKrVKoNm28mu5Nov1EZuMH2HgvWX1VdXW1++ouFytweXK00FgWFoKS1bCw24E3RUKDvWm8G9CjDU7OvJRd0d6f3HFzNDCyydnHNemN5swvdprTbVvUhqz5k1YesCpVVH7LqQ1Z9yKoPWfUhqz5k1Yes3HvVh6z6kFUHpOqAVB2Qqg9ZaWGlhf+nWvjt9CHlIzpLa3uWWY1zTVEvLzSuGfi9NkHL7YZCCWadkLKzAVs/bG+ptLOuAbQZ3O7W/e2PqoFbNXCrBm7VwK0auN9UA9fsRp7ZP6Bnegbt1m7TaTTcEZiiVkvYbafVsLvtLrf3Oh2nuyvgr9ewHmwPL3v7XbvRHDa6B+29g9b+Sje/MCLtMLfr9WUB7ENwGMTsKAzBaNtsIOIkDMCGS+0HzClYNlIuVUhkAIIsqQLymTrPLlUi+8rdIBp+BcmPPQ65RAwFoezARAYQr6WL8jZVkJtokJkrw3HlEhhwotaAYM1lA0Nf3xCDcV/Ind8B1iYV5XeBhPksnQK+P0vKViwr9gQfderdZtvrtDlv7rcbe7ujrsdbrXp3t0tVvimIEvjb9fV8EhbpMF85sCN/CvTMHHivT0jj4psnXQRjA/5j61mPzcg0+DI8Kr4NgcvL/lvW3mM+D8YJXefjBSYE9rvzVSVgDfgMLL5c2XJOM8DDo1e9dydokwdHP707Oh/eU+LuBSCtLooloAqyMFE6jjIE3HAIaYQP7BBujb0wUF8AQRBmFQdK/S2aR8BMZup+MMOsvmJGETTzQjUtqZKjz9Wz57ImattshNemPIbMbVSMxl6gWZnF9onh5As2gSxQhFs11nNdaXpk5FawKD8HQGBEXVRdDcBLQJUFHajHwBAitKUWWs7KpXaESX5OipuCygGYr5eTnhMngByRWdTCTFoMimZ/AGfNucUnBHKmEUvn4HvA4sJIf552B9kIaJNxxIw5wu2KwPAE6bjMYhVzOjJ3bzQyVPbGughPog307q0P5scm0rIb18IoH6bZxhrRbqTbZCwS3KRIHiebUdl2pYrPwJT7bqW7le5Wuruh7i7eHJhH6cxdCn1WPE/3LuAJ8Dck57kU+ugaZ6BYOkhnaHojt7E9ZEKkH98PQbF/FwG19T/OMAX+jPGRduVLyPey/dDXRxh+ZJtV2gtEkPioKfDAEgn3gPDOMS5Eia3l1V6pcCRBQIMVISJYzZDNVcI4sCxMgoDaZdE2c5WIgmcxm/BCvUDp+qQI8E0yMoirSLKKJCtvVHmjv483qiLJSncr3f0+dffBSLLc/TNxUpRMp5yKpSBp5j5SyxkMYOmhDpapXKEOnEcrCIxlMZZVjhysUbMxanh7jmi7vO12Wl2v6XSafHevsdcYtZvYG819/UWux5mSlXWqsN96H4nFEMRdQxyXBCBcUayUWy7/Jdje8dCsoenJ4mbgec0UvSl2bHaXY8ehUuwND+ZphBSVYsgg5xHaNBg7xbFhOhYGcDYGuxgwMFUS8EJRwuMPNgtBaPSbAlF5kQqAG87tnhcDKVpRUiHLVpGB4yeAIVkCX2HUrECwJBApPIz5AAJFsGOwzp8xOjVb9KRIng2Q4hN6N+LRR0cIVPQsct9dVd89Dsyj9ud6g+8p9JonOgIQAEgItM3K4s4qPq/i88rHVz7+7+Hjq/i80t1Kd79P3X1EfG6iofvjcxiwcXy+i4/LsSyWekWP/n/tMJ1UxWBA4s2U4yQhlZvTGJziChAlRGim6CngGccXeFs72cu70Zzg+74xHtSoJKEPIyZxPIsOdnZuYYdgZ+5qfCZr6ZGVQN3UHDXdGQFbVlgcfDRAaxcOYL23xyajqBFPQ4liq20cAdccTo9QRMBpqgY/CDl96HWuErBqBGYbH/c1IkSX8ZkUyB+epQfFkSNL9AFd70L/7um0aED30LKKfQ+uBuMZYLpAIpJwlb+e/RyDbb360kvacweCCVpzabEzHNZkLwUP8Twi9Sye//h+uMXG9OQJqjg+YD5mQpqzMW9BRMiE9dL6PU4irxKqZDwhxHulDgmqDPN8IJhdBudCsIv0MNgp2PYBGGNiKU4SpP846+p5ujuuuBY+ur1azkkUPOkGO8ChHV6at0UujnIBGejD8/io4WVgs0Npni3SD0kaEim1YxezlC5eoOtTkfhHCs3W0GyCFm0tYKFZe+HoJ24c0FsEwf2IuPXJi2t4dgEeJk5wBaEu4oCcMHiU+1pOumufjEcJno3wynhcBu/p+fTyNKbNVfp06TFzJkpF4l+MoeigGlyME9CiT0aLHoq3SSPsZr2Akq2XtKUN0SDhdwKKEWhh0uciKRhREKcFrlbJ32hnQed/oyMPv5VopssXeCQCRrrKiT4ZZ1zQxgVtbQMig7/2SShYoNtIA9kBLQD9fP/JEhhEC3ZPw1pp1Qn8Ds2hp+wAVYISzQ70l4PcwJlPjG7g6GwMmGEMprNOH3xnBhY6phKz0jLAIgeX8fUV+MMFvml8szIU+shvjV6kuJdXS/B48Oe20vdYkm/H7v5FFq+yNH9HS2PCW6w6DvLfzXKUJiLZo+GF9wF98ZMtD5zYzp7qzc5bP/1Yyxd8HUl1IGXxQMrCezC+znGRRwnUAydENnpQ/WsfCPnaJwPXHR/57glECUD3S2Jl6iJFp//S5K/L3Qxst00E/At3KXahygIos/4FXKhxRUAzEH308hTlOBMpqA46EzzGXHgbPa2aUmQyCxUKGb7UAQGN6fBCCCac+3wkfXxNB3bq0pU5BRA60UY/h9+jJDvR6kx4MBY19h4MQOCAm8KyFD5rBvc+KFOfOgdP9RYdHTtMnR8kodNpEuCrNgDtZMrAKKzzkK6MnEQHcqAzgUh5oSgVzmalUQ26XiShRgWacBqdedhi02Zsw7XAD0amvwasL8hnTshAmLeywLhyGWMdbPC+9kT4M3Q8YADAtBe95Jvj4RJEhfYf6HJETYXjHTMp2sGx+FIbIF6LT6vWqNVtKp/Qi7iiGIxyAXifdr3wgq1FAbzNe4p/m18YZzQcyzE7M2wdIG8SXR7SNbgLq1SDA6cyUWR0rNtbrCpjUeoOL/+hXT8egkrrTfgN4OnqMtmp3wVGB6adaQ/1sXdTvlzu06IN0jN0xfrBsVeFKuLbM6zdWyPze/CmuiAa8hu4iP8eWJfwP/q4mZZTGETXwbuYojiM0XDTLHBVEmQ+IJl3d/8D7L4yww==
sidebar_class_name: "post api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create SOD policy' (create-sod-policy)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Create SOD policy</h1>
<MethodEndpoint method={"post"} path={"/sod-policies"}></MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.
Requires role of ORG_ADMIN.
## Request
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Policy business name.","example":"policy-xyz"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional description of the SOD policy.","example":"This policy ensures compliance of xyz","nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Owner's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"externalPolicyReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional external policy reference.","example":"XYZ policy","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"policyQuery"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Search query of the SOD policy.","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"}}></SchemaItem><SchemaItem collapsible={false} name={"compensatingControls"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional compensating controls (Mitigating Controls).","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"correctionAdvice"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional correction advice.","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENFORCED`, `NOT_ENFORCED`]"} schema={{"type":"string","description":"Whether the policy is enforced or not.","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"}}></SchemaItem><SchemaItem collapsible={false} name={"tags"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Tags for the policy object.","example":["TAG1","TAG2"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>violationOwnerAssignmentConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"assignmentRule"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANAGER`, `STATIC`, `null`]"} schema={{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Owner's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"scheduled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines whether a policy has been scheduled or not.","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GENERAL`, `CONFLICTING_ACCESS_BASED`]"} schema={{"type":"string","description":"Whether a policy is query based or conflicting access based.","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>conflictingAccessCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>leftCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Business name for the access construct list","example":"money-in"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>criteriaList</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of criteria. There is a min of 1 and max of 50 items in the list.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`]"} schema={{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>rightCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Business name for the access construct list","example":"money-in"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>criteriaList</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of criteria. There is a min of 1 and max of 50 items in the list.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`]"} schema={{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
SOD policy created
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Policy ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Policy business name.","example":"policy-xyz"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional description of the SOD policy.","example":"This policy ensures compliance of xyz","nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Owner's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"externalPolicyReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional external policy reference.","example":"XYZ policy","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"policyQuery"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Search query of the SOD policy.","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"}}></SchemaItem><SchemaItem collapsible={false} name={"compensatingControls"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional compensating controls (Mitigating Controls).","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"correctionAdvice"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional correction advice.","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENFORCED`, `NOT_ENFORCED`]"} schema={{"type":"string","description":"Whether the policy is enforced or not.","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"}}></SchemaItem><SchemaItem collapsible={false} name={"tags"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Tags for the policy object.","example":["TAG1","TAG2"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"creatorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Policy's creator ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"modifierId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Policy's modifier ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>violationOwnerAssignmentConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"assignmentRule"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANAGER`, `STATIC`, `null`]"} schema={{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Owner's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"scheduled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines whether a policy has been scheduled or not.","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GENERAL`, `CONFLICTING_ACCESS_BASED`]"} schema={{"type":"string","description":"Whether a policy is query based or conflicting access based.","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>conflictingAccessCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>leftCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Business name for the access construct list","example":"money-in"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>criteriaList</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of criteria. There is a min of 1 and max of 50 items in the list.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`]"} schema={{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>rightCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Business name for the access construct list","example":"money-in"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>criteriaList</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of criteria. There is a min of 1 and max of 50 items in the list.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`]"} schema={{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"name\": \"policy-xyz\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\",\n \"description\": \"This policy ensures compliance of xyz\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"externalPolicyReference\": \"XYZ policy\",\n \"policyQuery\": \"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)\",\n \"compensatingControls\": \"Have a manager review the transaction decisions for their \\\"out of compliance\\\" employee\",\n \"correctionAdvice\": \"Based on the role of the employee, managers should remove access that is not required for their job function.\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"TAG1\",\n \"TAG2\"\n ],\n \"creatorId\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"modifierId\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n }\n },\n \"scheduled\": true,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"money-in\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a66\",\n \"name\": \"Administrator\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a67\",\n \"name\": \"Administrator\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"money-in\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a66\",\n \"name\": \"Administrator\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a67\",\n \"name\": \"Administrator\"\n }\n ]\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Conflicting Access Based Policy"} value={"Conflicting Access Based Policy"}><ResponseSamples responseExample={"{\n \"id\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"name\": \"Conflicting-Policy-Name\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\",\n \"description\": \"This policy ensures compliance of xyz\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Owner Name\"\n },\n \"externalPolicyReference\": \"XYZ policy\",\n \"policyQuery\": \"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)\",\n \"compensatingControls\": \"Have a manager review the transaction decisions for their \\\"out of compliance\\\" employee\",\n \"correctionAdvice\": \"Based on the role of the employee, managers should remove access that is not required for their job function.\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"string\"\n ],\n \"creatorId\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"modifierId\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Violation Owner Name\"\n }\n },\n \"scheduled\": true,\n \"type\": \"CONFLICTING_ACCESS_BASED\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"money-in\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a66\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a67\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"money-out\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a68\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180866166b5b0016167c32ef31a69\"\n }\n ]\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"General Policy"} value={"General Policy"}><ResponseSamples responseExample={"{\n \"description\": \"Description\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c918087682f9a86016839c05e8f1aff\",\n \"name\": \"Owner Name\"\n },\n \"externalPolicyReference\": \"New policy\",\n \"policyQuery\": \"policy query implementation\",\n \"compensatingControls\": \"Compensating controls\",\n \"correctionAdvice\": \"Correction advice\",\n \"tags\": [],\n \"state\": \"ENFORCED\",\n \"scheduled\": false,\n \"creatorId\": \"2c918087682f9a86016839c05e8f1aff\",\n \"modifierId\": null,\n \"violationOwnerAssignmentConfig\": null,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": null,\n \"id\": \"52c11db4-733e-4c31-949a-766c95ec95f1\",\n \"name\": \"General-Policy-Name\",\n \"created\": \"2020-05-12T19:47:38Z\",\n \"modified\": \"2020-05-12T19:47:38Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink