LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/patch-sod-policy.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

157 lines
56 KiB
Plaintext
Raw Blame History

---
id: patch-sod-policy
sidebar_label: Patch SOD policy by ID
hide_title: true
hide_table_of_contents: true
api: eJztXVl3Gzey/is4PQ+xfNkUd4l6uUNTsqMcWfJQ9OTOSD4J2I0mkTQbTC+SGB/+91tVQG/cJTueSQ4T2yK7gUIBqOWrwqLPViScJJTx3Dq7+2x9jETYV0EsnuJeEk/gmSXd4CxSrj1TvnTmZ49QVlifFp8qlpqJkMdSBZeudWbNeOxMbpX7gcpZFSvm4wgJ3N6cM/MQKrkickI5w2pQqef76jFiycwFQsGY5WWZJ4XvRkzFExGyeMIDdncPzNxblXvLCQWPReGzCi/1N83lPxIRzul7PJ+Je+sTSyIkD7TY3Q+3N9fsA3L76dUkjmfR2fFxrJQfVaWIvaoKx8eTeOofh57T6dYaRyyKeeDy0K3eBwPxWyJDEbFQ+YIpj90M3v3UO39/eQ0vhxMZMRG4MyWDmDnAsQr8OaOBYf2b67dXl/3h5TVU6Pcvbm9/etO7vThnyCEjtqWIquxcsUDFwK8Abov0YmUojUUA4+5ndZjNXIW9ixR7lL7PRon0XQbN9z5cMvHkCBrtKoM5mfGQT0UswoimWwZ64ibwKoAX8E268DlyJmLKrbPPNH7wNIpDaMFaVKxQjwDMeBwmYnk+hzDAl+c4MDjUOJt6QthIIIdT5UqYV7cKbYgnPp35SLzhdOuntdOm3XbrXbvOTzt2rd527cZpq90etXij2ehaKHDYtojiN8qdI2/bWekxX0YxslIQKhI0mLhUciPGHUeFLgmH+nL5QCEQzFMo1kjTCDEPhZ48PvLF2X3wmuFo488Cz/hVPcLcDoSHn0EHRRhwX7MOD0UoAodqOWo6E0FEOoPqCtIY6edhKBwk1nMfpC4L3MX0AfURfz5I5VPnb7CxXhTJcTAVQQyEPDmmKjD9buKDghHNwAMGsKme44go6qMFCCW/D2AWHTQWQYzTwWczKEeUj3+JVGBTj/8HP+LrFZniYcjRTgC1aVR4rka/QB+s1fnEiaF5YTfp/DEewRB6MhAuG83Z3eBtn+GkgE48dxqtomzfgXEjdQHVAMGbhSgxMSgb8gmvVjRjnSJkUoaiNQIJEKGnwqlADRNBMsVmuOtSw1P1IOjDzOcOfjIPHDUjWwpij4zkSpOWXBgud3LUY/qFGRi0KWBYgQyYM5jB1DzGPByLGKV1gmyDFRG+QPEwneCeB7OjhzsudrKk0sfFtoHFB+4ngsYuEDce2Z5lbvPK1+KxqBfYfRn7JTOUVcdejEVYrN+s1fIa6ftClUy+0jLZg4wECHMMTY2SWM+4sY2zifTlzFosCtRSKU6J6e+LFU+HAkGjYMYRDLwLhiIsD2KFpTJI7+5RPu4tmAUXPpsph++5/do6cMBnxtcPoIakDZnu0GtTmXrZzzWdaVVnbziyabw3FDHzeKeVoCCuWgbL855Nu/Xe2P0yd5WNVDbanGNfeHH2haYlb2UKwjW3ZWCnbuZlTYRyPMnasAqya6RAN6OSOG8H9NSUvwKfUxTvi+vh5fDq4j38RFPn5u7upHPa8Lrg7Gr1zmmz69Tata5T56MGCM8C/lSsd8bR/0HDD62gJAOVaAaSpGWgUavhj7LsXgYuGnaAGiisH3rD/vcF4xYlMH7CFW6F5DQUcRIG0RIA+C5iAUhnZm6oanW7A1nrNTJlLdtkHNldFtBgAEI4udLUvHrda/CWfeJ0W3Zr5DVt3hi59kmr0T6teaI5crVl5u4NwDkNNhYpXtqzzTeIP1GhrrXI5s3r4bGf5r+jnTTAdh1ddB0cxslCBGPHkuis2hh8wR4nItDwsQDB4JshvwS/ao0aAC74M6zVzuhPtUb//XtdvzOh/4N43IARn8dkqc1dc3RDH0DRCo9XIWyJHYL6hmcAYgmGBAjKfMkBomFlnFAQksT3EfNljKUAbzfeIXQGaiNd9M7xvLoi87r+zt4ZOufDG4o1qgX0cXlO9ulfZWiRPV1U9tKrZU4hAlgH8Hmr43HuCtECi+eNWqJWP3UatU6za+2tTmlTrozA9M0JRpfbuk1mMxXGJd9Htc5jZZHDW4uqnyElF4ZCGlPkNIp8/N+//p0LzooYFMLU3S3fCh4C6P0NS++Qy79z8mWvpHu2h10bH7He9Tl7XiXviAzVmgjkGWNYrI4RBtV/9V7GcqyfpTSPSt37nj8AAmVTHvAxgdcHCU6FYGvIgRyFPqDGjowouDP4SiKSAoeNg5drKeAoAZ/VXIh1U7QcSz2rd2lVxnXdYic0psKoAPhO8wj4OeWmknYwYtFEJT76VAwHmJ4nTIbEaCkxT1CCi7qrv6gR85LAST3sSs8oItzdHTDQJvciCuZZBNCSgx0IkYGCMbm4fnsz6F+cw6Prm+FP2deSbcmeLtIE0QqSLnOBhUzncpO7itjvrGHvXR2ewI8GNrkcVaahQ+pkMWO0r/v+znhO4OLy/KuAB+PknsdDWumFTJTlYA1T2xMDhICXSGzHZDyjMEj8tQKXis773nXv3cUAntwOe8PLvlXBllZiqHMRc+lHjI9QmVEuM5YjnTqp3geGFrMzf4RDpxXqPtD04eU7UCiw4uit34UqmaE8X5oKpdHNedvqzLnvlwPbg1v/hm59WTQxuMkL/nO7YC90wpMyXgVeRwpsMw9WmNX5poil9pGnVmnCI4jsAdVm1ApGMu1Jmqr0eOIDUva4H6Eo7TfpK02CSdSwYKSdSlhM16X+gt5ZhUatdxfXF4PeVUFk8iebEtVlYUrLk6PcEElvV4uy0Bfj+t3R3n5SlQVdWDzLtZhBAa6hWuLElCYuyVqaR9ABWTGu3+GrrkzCOa1UZRDthAJnCUCLpKCiTkHylD/hl3aNkZ9iUqMBZAXlHspeav9Vhy/8yXxp17ZkS/czIrmzzvMSq7kqXJIwoESTnWPW6nEiAYaSHw5TzMsoaMfMgLLKfj6nv6e9ydcNdJ+e26TJq7Q7p0670XUor+I4vON1a069WW/ub46+T8Bf2Ogf0aKUrNKXsdhzYWZhjkPEEpRHLCCYPXJGnU690xm1RzXoW71z4jQbwmvWeaeTr98sNVH5AqonG6mWrOuS0mNGqZRBO2jzQZsP2vxn1ebCq/5GR78LgOXbAl685KBTvHvHOrqjBfK2pmibBGyWaN2RWcyznTsKlmVubcZ9bfYvQ+XlWdws91nnCMzqhPK2vFY5E1VKPBXTRbtkkt0M2O5iJysZpV2rHUfWpmTSH5ntWU3ufPO0jMnCFNMm6Y4ZY8g+lVIV+4p+MbWwb53dkf9yLF8Ii7+qUGehGiuKdzlCK+UeNoYrOwKT5YCjtLhXXEN8ydreZsv+hSac1gVX4NW3XJhcbFuYXF44/GIzuMqLOPXq3POebwZxcXyDGTTBtI6kJTqnabpEudk69delsNeblv6afLDR9U9rDUFB2ClBUDYEe4xN0QigY96t4rqUmY08G7BFh3QNmq12w6nX3RGYmWZT2C2nWbe7rS63Tzodp9sW8Ner5zNmxGeHR27b9caw3j1rnZw1T9e64qUSC7Oe3Vq3hN0HABfE7CIMwSDbbECL1CCYUtt4s7OMjZRLSRUZgERL9ysuULuUu+wrdw/E+hYCHXscctrWJIhlByoien+Qrt5IB4GIJpm5KSxXTprBSFTrAKhcNjD965vOIDYLufMr0NonBf0xkL8l5HapCgCBLABb06w4EXzUqXUbLa/T4rxx2qqftEddjzebtW67S3nBKYgS+NLd+X8SFukwXzkwI78L9Locxp4YoMatvcMoorHH+OMatS6bddPwy3BnbAVAyZv+B9Y6YT4Pxgk95+OlQQjsj7frksaa8A0Ycbl2bTqN6c4v3vY+XqFxHlz84+PF7XBDUrwXgLTS/gxgFWRhojRGMh145ABXhE97tqrstaH6GjrEzSYNU1Dqb9E8gsFkJlcINUzra2oUSTMvVNOSKjl6GzF7JauiWmEjfDal3XujItJ6jWZlFttXZiRfswlEaiI8qrKe60qzokb+BdP4c9qD5rqoupqAl4AqAzMyniDoA/QFBrY8F/lQrixgmADlqjgpqBzA+R5b6pw4Aeaom0UtzKTFsGjmB3jWI1fmblgYNBrSOfgesLhQ0p+na4lsBH2TccSMOcLpisDwBGm5zGIV4y4yd+81M5QoxxwIT6I99O6DD+bHpq5lLx6EUb6IdiOTNaLZSKfJWCSzk5Yqm1LZdKWKr7fGHnT3oLsH3d1Td5dfDszGPfOWoE99Ffp8DHgC4xuS81yBPjqhGSiWFtLRl57ICq4oGYj0w49DUOxfRUC7AJ5mGN5+RXykXfkK871sPvTzUbpPOXX9+VwggzSOugceWCLhnhHfOccFlNhcbe2tCkcSBDRYAxHBaoZsrhLazB8mQUArbFGFuUpEwXcxm/BCLkBlpzdsOr5xQJIHJHnwRgdv9NfxRgckedDdg+7+OXV3K5Isr9AZnBQl0ymnZClImnmPveUMCrD0CEm+MbOQEM7RChJjGcayysjBGjXqo7p34oiWy1tup9n1Gk6nwdsn9ZP6qNXA9cvc19/lepwpWVmnCvOt55GGGEDcA+C4JADhimKl3HL6L8GlGw/NGh1+S3EzjHk1PTBD2LG1ih2vVQx9A8KAHcMN6cWPgyu9rKzJ47ipJMQDA2G2Bo2rSAgpaR1JPOntDAfoeICOB/dzcD9/DfdzgI4H3T3o7p9Td58FHVu7oGPrGdCxxRBieQix/pPQ0QXcgdDMg0mBPjgJDG8QL51sztTeXKeQAr0Simx0V1HkUCn2ngfzFCxFpUxkkA8XmjcoO8WyYVoWCnA2BhMZ4GUTEtAtShWetgVMihef+HIqSY+xQ0A3nNs9D++B0DqTylvWigwcPwEOySj4St+S8sgliJPwEP4BBcqDjsFQf8Ucp5mtL8oHswH2+Ap7zC6e9BF1luV/2+sPupujnbd6rjdsFzCbgAMII8TTTJuvDIIeoPoBqh/c/cHd/zXc/QGqH3T3oLt/Tt19BlQ3aGgzVIcCe0P1Nh6MYBmWekuHTr81YidVMRyQeDPlEFZ3cwxOuAJEKbu+0spvUsquvAR7cvxZugt4pyMAzVAS+lAsvVjuM8wTzM+iymeymh6YDtRj1VHT44fmGquDm0yj9EyWm+jdwXhho26kSqMbShRgbe2oAT3W6THeCMacdhdspZ8edJpDBMI0mQoeGTfCRI9xjzNEEt9F5ui1vuJsqY/Qt4+hv9jVn382t/VDE9nQj3XDt7UtKM+Ay6XuIfu4sdrcbHqLkFu3vnK/ae5GMNnfWGnsBos12BvBQ7wKg/a/vPrhx+GRuYYTFV3fLSpkrI9mfwARIUPWS/eCYCXyLaFKxhNivFfabYOKwzwfOszug1sh2F16FcE1WPgBmGQaUqwkyApgrfxaQ1c8CB+dXzUfSRQ86QbHMELHvFTviBwdRQQy0Dc24ZGU+8Bm59LsU9eHaUwXKcBjd7O0X7zQr5cy8beUmq2p2UQtOlriQg/tnaN3bzugvUiC+xGN1osb1/TsAj0Mn+AJUl3mAUfC8FHeI+Wks/ZiPkr0bKRX5uM++JHOI5arMW200lNIl8yZKBWJ/2UMRQfV4G6cgBa9mC06BGmTRtiNWoElWzdpSxswIfF3BYoRaGHSt3IQJFE6O0Iq+TPNLOj8z3RW9udSn+nxHZ6lhZKucqIX84wN2tigrW1AZPjXngkFC3Qb+0B2QAtAP59/sgSG0YLN07TWWnUif0x10DU4wCpRiWZn+stZbuDMJ0YvsHRWBkwwQups1xh8Z4YWuqfSYKXJgOURXOXXV+AVl8ZN85staaKn/G/rL/a4l+dM8HKar22lN1iS/x67+x+yeAdL81e0NAbkYu5xkN+dfVE4pP6se0RX7pfFe7ZAlKlLJtIoKpBGgqvZQbrbXMC/8JasACF1iIMosiN8VCQDzMWoL2QvnIkUlFeYCR4jqqygzKop6ThAaTQseDkPEhrTkbIQBoNDJCh9vG6J/QiBW+DA9GHQhvt5geovykRvtzCDdDUyO0+FAsDZdJoEeAESMJFMGQfR2yE5roycRBs4iOECkfZMX2af1Uq1HUUSh6JK4Us4jW48TEDrw4N7tgXyEZnsMwxk4VRo3pGB8LNLg8vQfhdtkEp7IvwZho1gnQGoiUIL7y+HKxQVno3USx5407apFB1jWbxqDDqvhaFZhWCRbrFWUQwxboGuvuu7eIn8XF99tnS7Z5ZxP/w6gW/86wSMV8Zw6niGCUCcyESHd9qU3FnFQBqqnEkXD7ZPFB1Htj5/xgwRhpULfPybPpGLx2LTqJHMFAgifs7Pw24UgVdmTN0jWuPa85cRrO1Imu8M5gUbCB9/FZghgX7QaWydwiIu9QuzZmLjvSuFituux8dgW1fWGbIt1cjoZlkLuosZSo/Mr0SY6gxMyB/hIf57Zt3D/xb+sg6t+lCInn+20nwmlNGEU8C5Dm+ZDzAzUOz/AaEVW1c=
sidebar_class_name: "patch api-method"
info_path: docs/api/v3/identitynow-v-3-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 'Patch SOD policy by ID' (patch-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 TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Patch SOD policy by ID</h1>
<MethodEndpoint method={"patch"} path={"/sod-policies/{id}"}></MethodEndpoint>
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Requires role of ORG_ADMIN.
This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy being modified.","example":"2c918083-5d19-1a86-015d-28455b4a2329"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
The following fields are patchable:
* name
* description
* ownerRef
* externalPolicyReference
* compensatingControls
* correctionAdvice
* state
* tags
* violationOwnerAssignmentConfig
* scheduled
* conflictingAccessCriteria
</div></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The value to be used for the operation, required for "add" and "replace" operations
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.
</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 this 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"}}>
**Possible values:** `>= 1`, `<= 50`
</div><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":"Type of the propery to which this reference applies to","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"}}>
**Possible values:** `>= 1`, `<= 50`
</div><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":"Type of the propery to which this reference applies to","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\": \"Modified description\",\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:2c918087682f9a86016839c0509c1ab2)\",\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-modified\",\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-modified\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c918087682f9a86016839c0509c1ab2\"\n }\n ]\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"General Policy"} value={"General Policy"}><ResponseSamples responseExample={"{\n \"description\": \"Modified 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"}><p> An example of a 403 response object</p><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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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"}><p> An example of a 500 response object</p><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