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/put-sod-policy.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

132 lines
64 KiB
Plaintext
Raw Blame History

---
id: put-sod-policy
sidebar_label: Update SOD policy by ID
hide_title: true
hide_table_of_contents: true
api: eJztXVt32zYS/is43IfEPaasuy2/7Cq2k7rHsVNZ3mzXyWlBEpSQUoTKixM1x/99ZwbgTZItOXbSy7KXRCKBwQww881ghqA+W2ouIp5IFZ561qE1T5NL5b1RgXQX1q6V8ElsHV5blxfHzFx8v2t5Yh4JlycCeiRRKnatWLhpJJMFtP1sXcUiOlJhIj4lwzSZYn/phYex8uw50Tj8CG2F9f6WaMVuJOfIAAw/nsqYpXMPaMeMs3guXOlL4TFkQHduvAtH4rdURtAiUoFgymcXo1c/D49fn543gOc5j/hMJCKKiRuJdOcc+Ni1QrgB36QHn2N3KmbcOvxsJYs5Xo2TSIYT63bXijT9XLplHgU7PcZhE/hUMMYSZVhHLsQnPpsHSFf4nQN/0O1098Wg2+u3nZ7jHHTbXd7rdwb73oGF04BDijh5obwFsrTMgYvTGSZ4i8/nMBqt2N6HGDn6vCqLcj4IN8HJiHB9EylivAuCr8i7LJ5eZpCwKkXTb7X8Nu/a++6ga3cdv2PztuPZ+91276Dpi47jCQvl4N5FGCw047fZlG85qJPGMhRxzLBXdXw9x/anxe+4Qi6MQ+q3SthX0YzDTFm4EnYiZ2JlNFxBvME+TkUIqwg6V1pG+GbIVzloN9tNu9mC/8bN5iH912jSP/9dJ/hMeaS6X4vHjP6jmKyMuWmRLugDD1jp8qoZVPkhgzZMizBO0WpdBTclD12yXVxRUJM0CLiDXQxn6mMoopHw1yn1ElvY8lnMpAcWAhjUWFF73X+jeIbO8fiCYUsSJExniF+nxyfn49PxT4h+hXD5VeB3G9Na5nTFyNruoHXQ5N2+z7knRLfZ6vtOVzRbB267CWhhbW1Q2VCejOcBX6wxqMt0PldRYt0CTWCGrlGv40ThOIDeIoLV1qYJKyEiAUv2ADXJKGTrH2U0qoz856f/mhbr9EDf+TEV0WLz0JeCR+6U/YatN2nmv7jrAtQ8l97hFtg22WHD82P2sE7+DmEVqDuoPiB2OEG3CE4rfsAslrsz1/Rnz1/LRE70xYzoTlXA7/mNAB864yGfiAhm/0aKjzQlScSBoEv264GHjeFDzACU8K6M2DtLpQnOX2Gp7ywm4LNaCLFulVwVQUSABIfejXyQlhRdGae+VSle8BjcvwqJ8czf4+eMnd1MwpjFU5UGHkg6Uyg6LRW05QniZagSlrnVkqwflMP8NCQGGutEixPA6M3yvJ0KIEhUSyAtQhjJRQEiZKAMKSfnLy9GRyfHcOn8Yvxz/rWCMPnV2ywWy/ngUcQXq24DGmXSZXxo3KxM67U1Hr5qwRX4q41DQjw2W6OVt5mvVdHp1rHDM+NAgYuniiKMs3sYE1mnL+WiqgpruLqRKqBAjHBzGMdyEs4A2sEgfTlBTpdJ3B+e8ZzCKA3W6lymPK+H58NXJyO4cjkejk+PrF0caSWcPhYJl4AW3EGDRpXIWY4ZeViIpg0tZud+CedO29S7UNOHm6/ApgDN0Wu/ilQ6R5U+NR0qs1vwdq9T50Fw4VOEXrv3b+/el1Xz9n254b/vV+xbvXvyQEnL0+IogGcerjB7LHyM6jGSJYjkGTBNecwcAeFtTq2Mk5ko2R7M52kAMbPPgxh1abtVf7s8JoCyDg8c7Vgi9Kk+3CJXanwG3WtYpVGtVyfnJ6PhWUlpiitHF+cvz06PxqfnsA09Ojq5vPz5xfByGcuz9uQu8yGHNOIRbogjye83jKraB8JPyv3ub72dXr0ob8ByP2JmBbiGbqmbsEDGSUXbZioUCxu22uQvNE9n2GiTv8JGFGmYTg3GYOcTCVwniF0kbTBajIceQNIn/NJrMnJWTOqYAHnBpVr2YHfMw11qU7hlMPmzk9fwt7WKpwY7rKqPLnpsiRRF+kBziamDj1MJoStt9PJAmdFmH0wHbHYVSA56/QO31x64fQCSA9flfX/QdFudVmd7IPk+BaS30bMhFlTw5HEsDj1YPFiaCOMAQKHbcvSRc1WeOz11mWz9fqvfd3pOE2Rr9ffdTlv4nRbv94s0ztIQu4+gun8n1QouLhkrporkZFpbYW2FtRX+cVZYunV0p2PdFPIUWe9ijkhVSySZpsn0ntQ0hyY3PEhFll/denehBS2RtzVF+5xTPjDPcW5I6hWJxg0Nqzr32nRjx6XLa/NueRxcXcW79T4XjsJHRvLcl1GqpoDW50u+ZjpjNXvxzdMOJstQzgpktReDGe8rO/Fttay8cd62z+Zt7fJGtbTne1L9yfchrKxJ1e1HZWN9ZyS+IeZejqXN+LlDXfanj8POR4IkANeawKPCMij8k/J88DieB4TguHCvBKwjD9aB5xPD037/oO0P+AGpV2fgNnviwG9x3384PJ0D0OTwVElIm29mSynRaaBVcMPtHVB2tC6lux6HjpazowUwvF+LGiXLoJ1yFTW2mJsyYqDD3IwHupVZjWJXfI/B6R60Wr2222p5DmBSpyPsrttp2YPugNv7/b476An4328VK2bUZ4On7Nmt9rg1OOzuH3YO1rrIpRa3t1o7IxHPwXdox99uNlfVsiiEMwcTPFZdm61rs3Vttk7e1rXZujZb12br2mxdm61rs3VttnbvdW22rs3WVaG6KlRXherabG2FtRX+n1phXZt9VG22fPnPUJutFj9KGZdNOskuRmxzs/2VTM6mutR2dAc7dxdj6rpyXVeu68p1XbmuK9d15a9VV+6uKyUfQVAYJuwkigC9bTYSSRqFoJhSOwRzIpg5yqPMiAxBoyVlPp6o4uxRBvJIeVtEwS9h02NPIi6RQ0Esu9CRAcUb6aG+zRTsSTTJ3Kdhu2rqC2ai0YIgzWMjI9+REQbjvYi7vwKtbTLJV6GE/izrAkFAvhlbM6zYF9zpNwftrt/vct4+6Lb2e87A551Oc9AbUHZvBqoEjndzHp+URbosUC6syO8CXTSHuScGaPDtN1tEY4v5x5KzbpuLafhleM5+FyKYF0dvWHefBTycpHSdT5YmIbSvLtelfjXhC4B+ubbUnO38jk9eDq/OEJxHJz9enVyO70htD0PQVg/VElgFXZgqHVAZAT5yiG1EANMhvAb7zlD9DgSCeKvcUOpv8SKGyWQm3wc9zOhrepRJMz9Ss4opufqlBOy5bIjGLnPw2ownsGNzymHZdwgr88Q+MzP5HZvC7k9EOw029DxpamPkXzAZvwBCAKIemq4m4KdgysCMTKYYIUKotlI6K6ZypQxhNj1n5UVB4wDON+vJ0E1SYI7ELFthri2GRbM+wLOeueUnA4pJoyldgO8BxIWWwSKrCjIHZJNJzAwc4XLFADxh1i5HrPJejuDutWaG0t2YD+FpvIXdvQkAfmwSLb9xI4zx4fbaoBGtRrZMBpHgJoX02Nm0ypcrM3wGUB54te3Wtlvb7pa2u3xzZB6gM3cp9Gmthj5XIU9hfiNyniuhj85thopljfRWTS/kLpaFTIj0w9sxGPavIqRy/qc57oWfMD7SrnyF+WG+Hvq6g+FHvliVtUAGaR61BD4gkfAOie+C41KU2Fkd7aWKHAkKGq4JEQE1I7ZQKeMwZVEahlQmi3eZp0QcPkvYlJcSB0rnJUWIr+GRYVJHknUkWXuj2hv9fbxRHUnWtlvb7l/Tdu+NJKtVPxMnxelsxilZCppm7qO0nEEDlh3lYLnJlRLCRbSCxFgeY1nVyMFy2i2n5e+7ouvxrtfvDPy222/z3n5rv+V021gTLXz9dWHHuZFVbaq03nodaYohiLuBOC4NQbniRCmvmv5Lsc7jI6wh9ORxM8x5w2S/dezYXY0dz1UCsgFhiB2jO9KLV6MzXarW5HHeVBrh4/9RXtfGkhOGlFR0Ep/0ow116FiHjrX7qd3P38P91KFjbbu17f41bfdBoWN3U+jYfUDo2GUYYvkYYv2RoaMHcQeGZj4sCsjgpjC9IYaNcxAle2wgN/uERxOR5IFeJYpsD1ajyLFS7DUPF1mwFFcykWExXQhv0HaGbaOsLTTgbAIQGTJALQnRLWoVHp6FmBT0hwVyJsmOUSCgGy3soZ+AVNpmMn3LR5GhG6TAIYFCoDD3qkDHJKiT8DH8AwqUB50AUD9hjtOs1qPywWyEEp+hxOzkkysE2nye/+2te0rgNDQHNS/1Wt/xuIB5HjiEbYT4NNfwlYegdaheh+q1u6/d/d/D3dehem27te3+NW33AaG6iYbuDtWhwdaheg8PW7A8lnpJB0e/dcROpmI4IPVmyqVY3SticIorQJXMb/EghuBP1xxae/nP5wCa7H2W3q2FP7uDMaFmJ40CaDZNknl8uLf3GVYJVue2weeykR16DtXHhqtmew5MzRrUwYdMtYVhAzZ8c2o2GA2a10ii6mqcI+J6lrNDuDHMNj1XcC/l7NjUAvYeTJPZxQNjRo3oMj7dDHuIZ9mrhnBWVuQDua6i4PbxsmhCd8iybvruHQ3aM+B0SUQU4X3xK0mXGHDr0Vd+K6lwIpjqb68MdoHN2uyF4BG+0YKefnn+w9vxDpvQM8xo5nhEccKETPTp6jegIgRjw+xJEOxEniVS6WRKjA8rz9qg2TA/AIHZu/BSCHadvU7gHPB9BIBMU4qdBGEA9nr/PFsdT9yIAF1fo5hJVDzphXswQ3u80m+H3BztB2SoX7+Ep1fehTY7luYpdX3uxohI2zt2Pc/k4iW5vpSJf2TUbE3NJmrxzhIXemqvXf3stgu2iyR4ENNsffHgmp5dooebJ7iCVJd5wJkwfFSfkHKzVftiPir0bKRX5eNd+JZOOFa7MQ1Z2YGlU+ZOlYrFPxlD1UEzuJ6kYEVfzBYdq7TJIux2s8SSrYe0pQ0RIfF3BoYRamXSb9aggETp3AiZ5C+0smDzv9Ch2V8qMtPlazxUCy095cZfzDMOaOOAtsaA2PCv/RIqFtg2ykA4oBXgqFh/QgLDaAn3NK21qE7k96gPugYXWCUq8fxQfzksAM58YnQDW+dtAIYxoM6fGYPvzNBC51SZrCwVsDyDq/wGCnzi0rxpfvOCJvrJP5u8KPGwyJjgC2aeGqXvQJI/D+7+QYhXI83fEWlMiIuZx1Hxi4cn2WYkP21YeqPk2mhri7cWbn2i7553/uTnw/I39jz+pPRXfKFdfcZ5+Yzz0pvUvs0J5Acp1D2Hjrc68vitzxh/63dLbDqR/JcXEDUA3S+plcmNlJ3+C7N/Xa1oYMltKuBPuEuxC2UXwJgpG0UWVyY0B9VHL09RjjuVgnKhc8ET3AvvoqdVM4pM5pFCJcPXgiGhCR2DjQDCecAdGeCL3rBal43MKYDQG230c/g9TvN3orhTHk5Eg70FAAhdcFOYmsJTC3DvgzI5qkvwVG/Q0bHjzPnBJnQ2S0N8WRuwnc4YgMImD+nJ2E11IAc2E4psLhRthfNeWVSDrhdFaFCSJprFFz6W2TSMbTkW+MHY1Nhg6kv6WQgyEua9ftCumsbYRBu8rz0VwRwdDwAAQHvZS74+Ha9QVIj/urCrosme6RTvYVt8LSIIr9Wn02g1mjalT+hVrnECoFwifkU/ZVx+sXH2wuulFxPn1cUn+fVmY2OYENmbYwIfuUt1gkanwq6tcioMuhyCCQK4TxUZv/X5M2Z4MTl0i5d/0y4Yj7VneR+CCJhi/FycZ79TrOeGY2+HatSbf/t5rQxZqSJcFFlKCz7+KjBAABEI7HT2mRjUN0y50x7rlyplHVfquIhPuofOaN/b9n0py/jmCpXIMT88PdP50oh/hIv456H1Dv5F9zfXKgyN6Do4HpMzhzaabLZBXLc/Mh9gHaDZ/wBdTxDc
sidebar_class_name: "put 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 'Update SOD policy by ID' (put-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"}>Update SOD policy by ID</h1>
<MethodEndpoint method={"put"} path={"/sod-policies/{id}"}></MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
## 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 to update.","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><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={"200"} value={"200"}><div>
SOD Policy by ID
</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\": \"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: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\": \"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"}><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={"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"}><Markdown> An example of a 404 response object</Markdown><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"}><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